Api Tokens - Create

Criar um novo token API na aplicação a utilizar na IoT Central Public API. O valor simbólico será devolvido na resposta, e não será devolvido novamente em pedidos posteriores.

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

Parâmetros do URI

Name In Required Type Description
baseDomain
path True
  • string

O domínio base para todos os pedidos de serviço Azure IoT Central.

subdomain
path True
  • string

O subdomínio da aplicação.

tokenId
path True
  • string

ID único para o token API.

api-version
query True
  • string

A versão da API a ser chamada.

Corpo do Pedido

Name Required Type Description
roles True

Lista de atribuições de funções que especificam as permissões de acesso à aplicação.

expiry
  • string

Data em formatada com cordas que representa a hora em que o token expira.

Respostas

Name Type Description
200 OK

Com êxito

Other Status Codes

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

Headers

  • x-ms-error-code: string

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

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 de símbolo de acesso da API.

Error

A definição de erro de resposta.

ErrorDetails

A informação detalhada do erro.

RoleAssignment

A definição de atribuição de papéis.

ApiToken

A definição de símbolo de acesso da API.

Name Type Description
expiry
  • string

Data em formatada com cordas que representa a hora em que o token expira.

id
  • string

ID único do token da API.

roles

Lista de atribuições de funções que especificam as permissões de acesso à aplicação.

token
  • string

Valor do token da API.

Error

A definição de erro de resposta.

Name Type Description
error

Detalhes de erro para pedido atual.

ErrorDetails

A informação detalhada do erro.

Name Type Description
code
  • string

Código de erro.

message
  • string

Detalhes da mensagem de erro.

requestId
  • string

Id de correlação para pedido atual.

time
  • string

O tempo que o pedido de erro falhou.

RoleAssignment

A definição de atribuição de papéis.

Name Type Description
organization
  • string

Identificação da organização para esta atribuição de papéis.

role
  • string

Identificação do papel para esta tarefa.