Api Tokens - Create

IoT Central 공용 API에서 사용할 새 API 토큰을 애플리케이션에 만듭니다. 토큰 값은 응답에 반환되며 후속 요청에서 다시 반환되지 않습니다.

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

URI 매개 변수

Name In Required Type Description
baseDomain
path True
  • string

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

subdomain
path True
  • string

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

tokenId
path True
  • string

API 토큰의 고유 ID입니다.

api-version
query True
  • string

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

요청 본문

Name Required Type Description
roles True

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

expiry
  • string

토큰이 만료되는 시간을 나타내는 문자열 형식의 날짜입니다.

응답

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

예제

Create API token

Sample Request

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

{
  "roles": [
    {
      "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
    },
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ]
}

Sample Response

{
  "id": "testtoken",
  "roles": [
    {
      "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
    },
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ],
  "expiry": "2020-10-18T18:30:40.227Z",
  "token": "SharedAccessSignature sr=..."
}

정의

ApiToken

API 액세스 토큰 정의입니다.

Error

응답 오류 정의입니다.

ErrorDetails

오류의 세부 정보입니다.

RoleAssignment

역할 할당 정의입니다.

ApiToken

API 액세스 토큰 정의입니다.

Name Type Description
expiry
  • string

토큰이 만료되는 시간을 나타내는 문자열 형식의 날짜입니다.

id
  • string

API 토큰의 고유 ID입니다.

roles

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

token
  • string

API 토큰의 값입니다.

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입니다.