CompassApi
CompassRequests
api
compass-api
compound-types
graphql-types

Rate this page:

@atlassian/forge-graphql / compass-requests / CompassRequests / createExternalAlias

Method: createExternalAlias

compass-requests.CompassRequests.createExternalAlias

Callable

createExternalAlias

createExternalAlias(input): Promise<ApiPayload<ExternalAliasPayload>>

Creates a new external alias for a component. An external alias is an identifier used to describe a component in an external system.

Required Oauth Scopes

  • write:component:compass

Parameters

Returns

Promise<ApiPayload<ExternalAliasPayload>>

Defined in

requests/createExternalAlias.ts:29

Rate this page: