Users - List

애플리케이션에서 사용자 목록 가져오기

GET https://{subdomain}.{baseDomain}/api/users?api-version=2022-07-31

URI 매개 변수

Name In Required Type Description
baseDomain
path True
  • string

모든 Azure IoT Central 서비스 요청에 대한 기본 도메인입니다.

subdomain
path True
  • string

애플리케이션 하위 도메인입니다.

api-version
query True
  • string

호출되는 API의 버전입니다.

응답

Name Type Description
200 OK

Success

Other Status Codes

IoT Central 서비스에서 받은 오류 응답입니다.

Headers

  • x-ms-error-code: string

보안

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 사용자 계정 가장

예제

List users

Sample Request

GET https://appsubdomain.azureiotcentral.com/api/users?api-version=2022-07-31

Sample Response

{
  "value": [
    {
      "id": "af0d5b8f-7a69-4521-868e-19745fae353f",
      "type": "email",
      "roles": [
        {
          "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
        }
      ],
      "email": "alice@contoso.com"
    },
    {
      "id": "123",
      "type": "servicePrincipal",
      "roles": [
        {
          "role": "c495eb57-eb18-489e-9802-62c474e5645c",
          "organization": "seattle"
        }
      ],
      "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
      "objectId": "9071c899-bce0-4862-b208-75dabae226a9"
    }
  ]
}

정의

ADGroupUser

Active Directory 그룹 사용자 정의입니다.

EmailUser

전자 메일 사용자 정의입니다.

Error

응답 오류 정의입니다.

ErrorDetails

오류의 세부 정보입니다.

RoleAssignment

역할 할당 정의입니다.

ServicePrincipalUser

서비스 주체 사용자 정의입니다.

UserCollection

사용자의 페이징된 결과입니다.

ADGroupUser

Active Directory 그룹 사용자 정의입니다.

Name Type Description
id
  • string

사용자의 고유 ID입니다.

objectId
  • string

AD 그룹의 AAD 개체 ID입니다.

roles

애플리케이션에 액세스할 수 있는 권한을 지정하는 역할 할당 목록입니다.

tenantId
  • string

AD 그룹의 AAD 테넌트 ID입니다.

type string:
  • adGroup

사용자의 유형입니다.

EmailUser

전자 메일 사용자 정의입니다.

Name Type Description
email
  • string

사용자의 이메일 주소

id
  • string

사용자의 고유 ID입니다.

roles

애플리케이션에 액세스할 수 있는 권한을 지정하는 역할 할당 목록입니다.

type string:
  • email

사용자의 유형입니다.

Error

응답 오류 정의입니다.

Name Type Description
error

현재 요청에 대한 오류 세부 정보입니다.

ErrorDetails

오류의 세부 정보입니다.

Name Type Description
code
  • string

오류 코드

message
  • string

오류 메시지 세부 정보입니다.

requestId
  • string

현재 요청에 대한 상관 관계 ID입니다.

time
  • string

오류 요청이 실패한 시간입니다.

RoleAssignment

역할 할당 정의입니다.

Name Type Description
organization
  • string

이 역할 할당에 대한 조직의 ID입니다.

role
  • string

이 역할 할당에 대한 역할의 ID입니다.

ServicePrincipalUser

서비스 주체 사용자 정의입니다.

Name Type Description
id
  • string

사용자의 고유 ID입니다.

objectId
  • string

서비스 주체의 AAD 개체 ID입니다.

roles

애플리케이션에 액세스할 수 있는 권한을 지정하는 역할 할당 목록입니다.

tenantId
  • string

서비스 주체의 AAD 테넌트 ID입니다.

type string:
  • servicePrincipal

사용자의 유형입니다.

UserCollection

사용자의 페이징된 결과입니다.

Name Type Description
nextLink
  • string

사용자의 다음 페이지를 가져오는 URL입니다.

value User[]:

사용자 컬렉션입니다.