Api Tokens - Create

Crie um novo token de API no aplicativo a ser usado na API pública do IoT Central. O valor do token será retornado na resposta e não será retornado novamente em solicitações subsequentes.

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

Parâmetros de URI

Name In Required Type Description
baseDomain
path True
  • string

O domínio base para todas as solicitações de serviço do Azure IoT Central.

subdomain
path True
  • string

O subdomínio do aplicativo.

tokenId
path True
  • string

ID exclusiva para o token de API.

api-version
query True
  • string

A versão da API que está sendo chamada.

Corpo da solicitação

Name Required Type Description
roles True

Lista de atribuições de função que especificam as permissões para acessar o aplicativo.

expiry
  • string

Data formatada em cadeia de caracteres que representa a hora em que o token expira.

Respostas

Name Type Description
200 OK

Êxito

Other Status Codes

Uma resposta de erro recebida do Serviço Do IoT Central.

Headers

  • x-ms-error-code: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

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

Definições

ApiToken

A definição do token de acesso à API.

Error

A definição de erro de resposta.

ErrorDetails

As informações detalhadas do erro.

RoleAssignment

A definição de atribuição de função.

ApiToken

A definição do token de acesso à API.

Name Type Description
expiry
  • string

Data formatada em cadeia de caracteres que representa a hora em que o token expira.

id
  • string

ID exclusiva do token de API.

roles

Lista de atribuições de função que especificam as permissões para acessar o aplicativo.

token
  • string

Valor do token de API.

Error

A definição de erro de resposta.

Name Type Description
error

Detalhes do erro da solicitação atual.

ErrorDetails

As informações detalhadas do erro.

Name Type Description
code
  • string

Código do erro.

message
  • string

Detalhes da mensagem de erro.

requestId
  • string

ID de correlação para a solicitação atual.

time
  • string

A hora em que a solicitação de erro falhou.

RoleAssignment

A definição de atribuição de função.

Name Type Description
organization
  • string

ID da organização para essa atribuição de função.

role
  • string

ID da função para essa atribuição de função.