Delen via

User - Get Shared Access Token

Service:
API Management
API-versie:
2024-05-01

Hiermee haalt u het autorisatietoken voor gedeelde toegang voor de gebruiker op.

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

URI-parameters

Name In Vereist Type Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

De naam van de API Management-service.
subscriptionId
 path True

string (uuid)

De id van het doelabonnement. De waarde moet een UUID zijn.
userId
 path True

string

minLength: 1
maxLength: 80

Gebruikers-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
api-version
 query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name Vereist Type Description
properties.expiry True

string (date-time)

De verlooptijd van het token. De maximale verlooptijd van het token is ingesteld op 30 dagen. De datum voldoet aan de volgende indeling: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard.
properties.keyType True

KeyType

De sleutel die moet worden gebruikt om een token voor de gebruiker te genereren.

Antwoorden

Name Type Description
200 OK

UserTokenResult

De hoofdtekst van het antwoord bevat het autorisatietoken voor de gebruiker.
Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementUserToken

Voorbeeldaanvraag

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"
  }
}

Voorbeeldrespons

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

Definities

Name Description
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.
ErrorDetail

De foutdetails.
ErrorResponse

Foutreactie
KeyType

De sleutel die moet worden gebruikt om een token voor de gebruiker te genereren.
UserTokenParameters

Haal User Token-parameters op.
UserTokenResult

Details van antwoord van gebruikerstoken ophalen.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.
type

string

Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.
code

string

De foutcode.
details

ErrorDetail[]

De foutdetails.
message

string

Het foutbericht.
target

string

Het foutdoel.

ErrorResponse

Object

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

KeyType

Inventarisatie

De sleutel die moet worden gebruikt om een token voor de gebruiker te genereren.

Waarde Description
primary
secondary

UserTokenParameters

Object

Haal User Token-parameters op.

Name Type Default value Description
properties.expiry

string (date-time)

De verlooptijd van het token. De maximale verlooptijd van het token is ingesteld op 30 dagen. De datum voldoet aan de volgende indeling: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard.
properties.keyType

KeyType

primary

De sleutel die moet worden gebruikt om een token voor de gebruiker te genereren.

UserTokenResult

Object

Details van antwoord van gebruikerstoken ophalen.

Name Type Description
value

string

Autorisatietoken voor gedeelde toegang voor de gebruiker.