다음을 통해 공유

Users - Create

  • 참조
서비스:
IoT Central
API 버전:
2022-07-31

애플리케이션에서 사용자 만들기

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
baseDomain
 path True

string

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

string

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

string

사용자의 고유 ID입니다.

regex 패턴: ^[a-zA-Z0-9-_]*$
api-version
 query True

string

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

요청 본문

요청 본문은 다음 중 하나가 될 수 있습니다.

Name Description
ADGroupUser

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

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

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

ADGroupUser

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

Name 필수 형식 Description
objectId True

string

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

RoleAssignment[]

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

string

AD 그룹의 AAD 테넌트 ID입니다.
type True string:

adGroup

사용자 유형입니다.

EmailUser

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

Name 필수 형식 Description
email True

string

사용자의 이메일 주소
roles True

RoleAssignment[]

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

email

사용자 유형입니다.

ServicePrincipalUser

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

Name 필수 형식 Description
objectId True

string

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

RoleAssignment[]

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

string

서비스 주체의 AAD 테넌트 ID입니다.
type True string:

servicePrincipal

사용자 유형입니다.

응답

Name 형식 Description
200 OK User:

Success
Other Status Codes

Error

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

헤더

x-ms-error-code: string

보안

azure_auth

Azure Active Directory OAuth2 Flow

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

범위

Name Description
user_impersonation 사용자 계정 가장

예제

Add or update a service principal user
Add or update an email user

Add or update a service principal user

샘플 요청

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

{
  "type": "servicePrincipal",
  "tenantId": "027fdad7-cf0f-470a-a26a-272197813322",
  "objectId": "65e13aac-1443-4c49-9d49-57b87197cfff",
  "roles": [
    {
      "role": "c7be2c6b-797e-4551-bb24-33709f6b2e20"
    },
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ]
}

샘플 응답

상태 코드:
200 
{
  "id": "123",
  "type": "servicePrincipal",
  "tenantId": "027fdad7-cf0f-470a-a26a-272197813322",
  "objectId": "65e13aac-1443-4c49-9d49-57b87197cfff",
  "roles": [
    {
      "role": "c7be2c6b-797e-4551-bb24-33709f6b2e20"
    },
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ]
}

Add or update an email user

샘플 요청

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

{
  "type": "email",
  "roles": [
    {
      "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
    },
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ],
  "email": "bob@contoso.com"
}

샘플 응답

상태 코드:
200 
{
  "type": "email",
  "roles": [
    {
      "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
    },
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ],
  "email": "bob@contoso.com"
}

정의

Name Description
ADGroupUser

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

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

응답 오류 정의입니다.
ErrorDetails

오류의 세부 정보입니다.
RoleAssignment

역할 할당 정의입니다.
ServicePrincipalUser

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

ADGroupUser

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

Name 형식 Description
id

string

사용자의 고유 ID입니다.
objectId

string

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

RoleAssignment[]

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

string

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

adGroup

사용자 유형입니다.

EmailUser

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

Name 형식 Description
email

string

사용자의 이메일 주소
id

string

사용자의 고유 ID입니다.
roles

RoleAssignment[]

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

email

사용자 유형입니다.

Error

응답 오류 정의입니다.

Name 형식 Description
error

ErrorDetails

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

ErrorDetails

오류의 세부 정보입니다.

Name 형식 Description
code

string

오류 코드
message

string

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

string

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

string

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

RoleAssignment

역할 할당 정의입니다.

Name 형식 Description
organization

string

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

string

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

ServicePrincipalUser

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

Name 형식 Description
id

string

사용자의 고유 ID입니다.
objectId

string

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

RoleAssignment[]

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

string

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

servicePrincipal

사용자 유형입니다.