User - Get Shared Access Token

Tjänst:

API Management

API-version:

2024-05-01

Hämtar auktoriseringstoken för delad åtkomst för användaren.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/token?api-version=2024-05-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Namnet på API Management-tjänsten.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
userId	path	True	string minLength: 1 maxLength: 80	Användaridentifierare. Måste vara unikt i den aktuella API Management-tjänstinstansen.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
properties.expiry	True	string (date-time)	Förfallotiden för token. Maximal förfallotid för token har angetts till 30 dagar. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt ISO 8601-standarden.
properties.keyType	True	KeyType	Nyckeln som ska användas för att generera token för användaren.

Svar

Name	Typ	Description
200 OK	UserTokenResult	Svarstexten innehåller auktoriseringstoken för användaren.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ApiManagementUserToken

Exempelbegäran

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/userId1718/token?api-version=2024-05-01

{
  "properties": {
    "keyType": "primary",
    "expiry": "2019-04-21T00:44:24.2845269Z"
  }
}

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
KeyType	Nyckeln som ska användas för att generera token för användaren.
UserTokenParameters	Hämta parametrar för användartoken.
UserTokenResult	Hämta svarsinformation för användartoken.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

KeyType

Uppräkning

Nyckeln som ska användas för att generera token för användaren.

Värde	Description
primary
secondary

UserTokenParameters

Objekt

Hämta parametrar för användartoken.

Name	Typ	Standardvärde	Description
properties.expiry	string (date-time)		Förfallotiden för token. Maximal förfallotid för token har angetts till 30 dagar. Datumet överensstämmer med följande format: yyyy-MM-ddTHH:mm:ssZ enligt ISO 8601-standarden.
properties.keyType	KeyType	primary	Nyckeln som ska användas för att generera token för användaren.

UserTokenResult

Objekt

Hämta svarsinformation för användartoken.

Name	Typ	Description
value	string	Auktoriseringstoken för delad åtkomst för användaren.