User - Get

서비스:

API Management

API 버전:

2024-05-01

식별자가 지정한 사용자의 세부 정보를 가져옵니다.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?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
200 OK	UserContract	지정된 사용자 엔터티를 가져옵니다. 헤더 ETag: string
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름.

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

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

ApiManagementGetUser

샘플 요청

HTTP

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

샘플 응답

상태 코드:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
  "type": "Microsoft.ApiManagement/service/users",
  "name": "5931a75ae4bbd512a88c680b",
  "properties": {
    "firstName": "foo",
    "lastName": "bar",
    "email": "foobar@outlook.com",
    "state": "active",
    "registrationDate": "2017-06-02T17:58:50.357Z",
    "identities": [
      {
        "provider": "Microsoft",
        "id": "*************"
      }
    ]
  }
}

정의

Name	Description
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
GroupContractProperties	그룹 계약 속성입니다.
GroupType	그룹 유형입니다.
UserContract	사용자 세부 정보입니다.
UserIdentityContract	사용자 ID 세부 정보입니다.
UserState	계정 상태입니다. 사용자가 활성 상태인지 여부를 지정합니다. 차단된 사용자는 개발자 포털에 로그인하거나 구독된 제품의 API를 호출할 수 없습니다. 기본 상태는 활성입니다.

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	오류 개체입니다.

GroupContractProperties

Object

그룹 계약 속성입니다.

Name	형식	Description
builtIn	boolean	그룹이 세 시스템 그룹(관리자, 개발자 또는 게스트) 중 하나인 경우 true입니다. 그렇지 않으면 false입니다.
description	string maxLength: 1000	그룹 설명입니다. HTML 서식 태그를 포함할 수 있습니다.
displayName	string minLength: 1 maxLength: 300	그룹 이름입니다.
externalId	string	외부 그룹의 경우 이 속성에는 외부 ID 공급자의 그룹 ID(예: Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>;)가 포함됩니다. 그렇지 않으면 값이 null입니다.
type	GroupType	그룹 유형입니다.

GroupType

열거형

그룹 유형입니다.

값	Description
custom
system
external

UserContract

Object

사용자 세부 정보입니다.

Name	형식	Default value	Description
id	string		리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		리소스의 이름
properties.email	string		전자 메일 주소입니다.
properties.firstName	string		이름.
properties.groups	GroupContractProperties[]		사용자가 속한 그룹 컬렉션입니다.
properties.identities	UserIdentityContract[]		사용자 ID의 컬렉션입니다.
properties.lastName	string		성.
properties.note	string		관리자가 설정한 사용자에 대한 선택적 참고 사항입니다.
properties.registrationDate	string (date-time)		사용자 등록 날짜입니다. 날짜는 ISO 8601 표준에 지정된 yyyy-MM-ddTHH:mm:ssZ 형식을 준수합니다.
properties.state	UserState	active	계정 상태입니다. 사용자가 활성 상태인지 여부를 지정합니다. 차단된 사용자는 개발자 포털에 로그인하거나 구독된 제품의 API를 호출할 수 없습니다. 기본 상태는 활성입니다.
type	string		리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

UserIdentityContract

Object

사용자 ID 세부 정보입니다.

Name	형식	Description
id	string	공급자 내의 식별자 값입니다.
provider	string	ID 공급자 이름입니다.

UserState

열거형

계정 상태입니다. 사용자가 활성 상태인지 여부를 지정합니다. 차단된 사용자는 개발자 포털에 로그인하거나 구독된 제품의 API를 호출할 수 없습니다. 기본 상태는 활성입니다.

값	Description
active	사용자 상태가 활성 상태입니다.
blocked	사용자가 차단됩니다. 차단된 사용자는 개발자 포털에서 인증하거나 API를 호출할 수 없습니다.
pending	사용자 계정이 보류 중입니다. 활성화하려면 ID 확인이 필요합니다.
deleted	사용자 계정이 닫혔습니다. 모든 ID 및 관련 엔터티가 제거됩니다.