User - Get Shared Access Token

서비스:

API Management

API 버전:

2024-05-01

사용자에 대한 공유 액세스 권한 부여 토큰을 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management 서비스의 이름입니다.
subscriptionId	path	True	string (uuid)	대상 구독의 ID입니다. 값은 UUID여야 합니다.
userId	path	True	string minLength: 1 maxLength: 80	사용자 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 본문

Name	필수	형식	Description
properties.expiry	True	string (date-time)	토큰의 만료 시간입니다. 최대 토큰 만료 시간은 30일로 설정됩니다. 날짜는 ISO 8601 표준에 지정된 yyyy-MM-ddTHH:mm:ssZ 형식을 준수합니다.
properties.keyType	True	KeyType	사용자에 대한 토큰을 생성하는 데 사용할 키입니다.

응답

Name	형식	Description
200 OK	UserTokenResult	응답 본문에는 사용자에 대한 권한 부여 토큰이 포함됩니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

ApiManagementUserToken

샘플 요청

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

샘플 응답

상태 코드:

200

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

정의

Name	Description
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
KeyType	사용자에 대한 토큰을 생성하는 데 사용할 키입니다.
UserTokenParameters	사용자 토큰 매개 변수를 가져옵니다.
UserTokenResult	사용자 토큰 응답 세부 정보를 가져옵니다.

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

KeyType

열거형

사용자에 대한 토큰을 생성하는 데 사용할 키입니다.

값	Description
primary
secondary

UserTokenParameters

Object

사용자 토큰 매개 변수를 가져옵니다.

Name	형식	Default value	Description
properties.expiry	string (date-time)		토큰의 만료 시간입니다. 최대 토큰 만료 시간은 30일로 설정됩니다. 날짜는 ISO 8601 표준에 지정된 yyyy-MM-ddTHH:mm:ssZ 형식을 준수합니다.
properties.keyType	KeyType	primary	사용자에 대한 토큰을 생성하는 데 사용할 키입니다.

UserTokenResult

Object

사용자 토큰 응답 세부 정보를 가져옵니다.

Name	형식	Description
value	string	사용자에 대한 공유 액세스 권한 부여 토큰입니다.