swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Aliases API schemes: - https tags: - name: Aliases paths: /aliases: post: x-publish: true description: '**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).

Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.

This API allows the caller to create an alias. You can also assign the alias during the create request. An alias can reference an ID generated by a creator service, but cannot reference another alias ID.

### Submit Create Request

To create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter.

### Create Alias Response

The Create API returns a HTTP `201 Created` response with the alias resource in the body.

A sample response from creating an alias:

```json
{
"createdTimestamp": "2020-02-13T21:19:11.123Z",
"aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766",
"creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14",
"lastUpdatedTimestamp": "2020-02-13T21:19:22.123Z"
}
```' operationId: microsoftAzureAliasCreate x-ms-examples: Create an alias that does not reference any resource: $ref: ./examples/Alias_Create.json parameters: - $ref: '#/parameters/SubscriptionKey' - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/CreateCreatorDataItemId' responses: '201': description: Content created successfully. The response body contains the newly created alias id `aliasId`. schema: $ref: '#/definitions/AliasCreateResponse' headers: Access-Control-Expose-Headers: type: string description: The list of response headers that can be read by the client. '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '500': $ref: '#/responses/500' summary: Microsoft Azure Post Aliases tags: - Aliases get: x-publish: true description: '**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).

Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.

This API allows the caller to fetch a list of all previously successfully created aliases.

### Submit List Request

To list all your aliases, you will issue a `GET` request with no additional parameters.

### List Data Response

The List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource:
> createdTimestamp - The timestamp that the alias was created. Format yyyy-MM-ddTHH:mm:ss.sssZ
> aliasId - The id for the alias.
> creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).
> lastUpdatedTimestamp - The last time the alias was assigned to a resource. Format yyyy-MM-ddTHH:mm:ss.sssZ

A sample response returning 2 alias resources:

```json
{
"aliases": [
{
"createdTimestamp": "2020-02-13T21:19:11.123Z",
"aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766",
"creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14",
"lastUpdatedTimestamp": "2020-02-13T21:19:22.123Z"
},
{
"createdTimestamp": "2020-02-18T19:53:33.123Z",
"aliasId": "1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6",
"creatorDataItemId": null,
"lastUpdatedTimestamp": "2020-02-18T19:53:33.123Z"
}
]
}
```' operationId: microsoftAzureAliasList x-ms-examples: List all the previously created aliases: $ref: ./examples/Alias_List.json parameters: - $ref: '#/parameters/SubscriptionKey' - $ref: '#/parameters/ApiVersion' responses: '200': description: List alias request completed successfully. The response body contains a list of all the previously created aliases. schema: $ref: '#/definitions/AliasListResponse' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '500': $ref: '#/responses/500' summary: Microsoft Azure Get Aliases tags: - Aliases /aliases/{aliasId}: put: x-publish: true description: '**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).

Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.

This API allows the caller to assign an alias to reference a resource.

### Submit Assign Request

To assign your alias to a resource, you will use a `PUT` request with the `aliasId` in the path and the `creatorDataItemId` passed as a query parameter.

### Assign Alias Response

The Assign API returns a HTTP `200 OK` response with the updated alias resource in the body, if the alias was assigned successfully. A sample of the assign response is

```json
{
"createdTimestamp": "2020-02-13T21:19:11.123Z",
"aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766",
"creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14",
"lastUpdatedTimestamp": "2020-02-13T21:19:22.123Z"
}
```' operationId: microsoftAzureAliasAssign x-ms-examples: Assign an alias to a resource: $ref: ./examples/Alias_Assign.json parameters: - $ref: '#/parameters/AliasId' - $ref: '#/parameters/SubscriptionKey' - $ref: '#/parameters/ApiVersion' - $ref: '#/parameters/AssignCreatorDataItemId' responses: '200': description: Alias was assigned successfully. schema: $ref: '#/definitions/AliasListItem' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '500': $ref: '#/responses/500' summary: Microsoft Azure Put Aliases Aliasid tags: - Aliases delete: x-publish: true description: '**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).

Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.

This API allows the caller to delete a previously created alias. You can also use this API to delete old/unused aliases to create space for new content.This API does not delete the references resource, only the alias referencing the resource.

### Submit Delete Request

To delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete.

### Delete Alias Response

The Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.' operationId: microsoftAzureAliasDelete x-ms-examples: Delete previously created alias: $ref: ./examples/Alias_Delete.json parameters: - $ref: '#/parameters/AliasId' - $ref: '#/parameters/SubscriptionKey' - $ref: '#/parameters/ApiVersion' responses: '204': description: Alias delete request completed successfully. The content for `aliasId` was deleted on the server. '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '500': $ref: '#/responses/500' summary: Microsoft Azure Delete Aliases Aliasid tags: - Aliases get: x-publish: true description: '**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).

Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.

This API allows the caller to fetch the details of a previously created alias.

### Submit Get Details Request

To get the details of your alias, you will issue a `GET` request with the `aliasId` in the path.

### Get Details Response

The Get Details API returns the previously created alias in `json` format. The response contains the following details for the alias resource:
> createdTimestamp - The timestamp that the alias was created.
> aliasId - The id for the alias.
> creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).
> lastUpdatedTimestamp - The last time the alias was assigned to a resource.

Here''s a sample response:
```json
{
"createdTimestamp": "2020-02-13T21:19:11.123Z",
"aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766",
"creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14",
"lastUpdatedTimestamp": "2020-02-13T21:19:22.123Z"
}
```' operationId: microsoftAzureAliasGetdetails x-ms-examples: Get a previously created alias: $ref: ./examples/Alias_GetDetails.json parameters: - $ref: '#/parameters/AliasId' - $ref: '#/parameters/SubscriptionKey' - $ref: '#/parameters/ApiVersion' responses: '200': description: Get alias request completed successfully. The response body contains the previously created alias. schema: $ref: '#/definitions/AliasListItem' '400': $ref: '#/responses/400' '401': $ref: '#/responses/401' '403': $ref: '#/responses/403' '404': $ref: '#/responses/404' '500': $ref: '#/responses/500' summary: Microsoft Azure Get Aliases Aliasid tags: - Aliases definitions: AliasCreateResponse: description: The response model for the Alias Create API for the case when the alias was successfully created. type: object properties: createdTimestamp: description: The created timestamp for the alias. type: string readOnly: true aliasId: description: The id for the alias. type: string readOnly: true creatorDataItemId: description: The id for the creator data item that this alias references (could be null if the alias has not been assigned). type: string readOnly: true lastUpdatedTimestamp: description: The timestamp of the last time the alias was assigned. type: string readOnly: true AliasListItem: description: Detailed information for the alias. type: object properties: createdTimestamp: description: The created timestamp for the alias. type: string readOnly: true aliasId: description: The id for the alias. type: string readOnly: true creatorDataItemId: description: The id for the creator data item that this alias references (could be null if the alias has not been assigned). type: string readOnly: true lastUpdatedTimestamp: description: The timestamp of the last time the alias was assigned. type: string readOnly: true ODataErrorResponse: type: object description: This response object is returned when an error occurs in the Azure Maps API. properties: error: $ref: '#/definitions/ODataError' AliasListResponse: description: The response model for the List API. Returns a list of all the previously created aliases. type: object properties: aliases: description: A list of all the previously created aliases. type: array readOnly: true items: $ref: '#/definitions/AliasListItem' nextLink: description: If present, the location of the next page of data. type: string readOnly: true ODataError: type: object description: This object is returned when an error occurs in the Azure Maps API. properties: code: type: string readOnly: true description: The ODataError code. message: type: string readOnly: true description: If available, a human-readable description of the error. details: type: array items: $ref: '#/definitions/ODataError' target: type: string readOnly: true description: If available, the target causing the error. parameters: CreateCreatorDataItemId: name: creatorDataItemId description: The unique id that references a creator data item to be aliased. type: string in: query required: false x-ms-parameter-location: method AliasId: name: aliasId description: The unique id that references an existing alias. type: string in: path required: true x-ms-parameter-location: method AssignCreatorDataItemId: name: creatorDataItemId description: The unique id that references a creator data item to be aliased. type: string in: query required: true x-ms-parameter-location: method SubscriptionKey: name: subscription-key description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. type: string in: query required: false x-ms-parameter-location: client ApiVersion: name: api-version description: Version number of Azure Maps API. Current version is 2.0 type: string in: query required: true default: '2.0' x-ms-parameter-location: client responses: '500': description: An error occurred while processing the request. Please try again later. schema: $ref: '#/definitions/ODataErrorResponse' '404': description: 'Not Found: the requested resource could not be found, but it may be available again in the future.' schema: $ref: '#/definitions/ODataErrorResponse' '403': description: Permission, capacity, or authentication issues. schema: $ref: '#/definitions/ODataErrorResponse' '401': description: Access denied due to invalid subscription key or invalid Microsoft Entra ID bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Microsoft Entra ID bearer token. schema: $ref: '#/definitions/ODataErrorResponse' headers: WWW-Authenticate: type: string description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" '400': description: 'Bad request: one or more parameters were incorrectly specified or are mutually exclusive.' schema: $ref: '#/definitions/ODataErrorResponse' x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'