Gateway - Generate Token

Gets the Shared Access Authorization Token for the gateway.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}/generateToken?api-version=2020-12-01

URI Parameters

Name In Required Type Description
gatewayId
path True
  • string

Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'

resourceGroupName
path True
  • string

The name of the resource group.

serviceName
path True
  • string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True
  • string

Version of the API to be used with the client request.

Request Body

Name Required Type Description
expiry True
  • string

The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

keyType True

The Key to be used to generate gateway token.

Responses

Name Type Description
200 OK

The response body contains the authorization token for the gateway.

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementGatewayGenerateToken

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/generateToken?api-version=2020-12-01
{
  "keyType": "primary",
  "expiry": "2020-04-21T00:44:24.2845269Z"
}

Sample Response

{
  "value": "gw1&201904210044&9A1GR1f5WIhFvFmzQG+xxxxxxxxxxx/kBeu87DWad3tkasUXuvPL+MgzlwUHyg=="
}

Definitions

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

GatewayTokenContract

Gateway access token.

GatewayTokenRequestContract

Gateway token request contract properties.

KeyType

The Key being regenerated.

ErrorFieldContract

Error Field contract.

Name Type Description
code
  • string

Property level error code.

message
  • string

Human-readable representation of property-level error.

target
  • string

Property name.

ErrorResponse

Error Response.

Name Type Description
error.code
  • string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

error.details

The list of invalid fields send in request, in case of validation error.

error.message
  • string

Human-readable representation of the error.

GatewayTokenContract

Gateway access token.

Name Type Description
value
  • string

Shared Access Authentication token value for the Gateway.

GatewayTokenRequestContract

Gateway token request contract properties.

Name Type Description
expiry
  • string

The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

keyType

The Key to be used to generate gateway token.

KeyType

The Key being regenerated.

Name Type Description
primary
  • string
secondary
  • string