Api Tokens - Create

Service:

IoT Central

API Version:

2022-07-31

Crie um novo token de API na aplicação para utilizar na API pública do IoT Central. O valor do token será devolvido na resposta e não será devolvido novamente nos pedidos subsequentes.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
baseDomain	path	True	string	O domínio base para todos os pedidos de serviço do Azure IoT Central.
subdomain	path	True	string	O subdomínio da aplicação.
tokenId	path	True	string	ID exclusivo para o token de API.
api-version	query	True	string	A versão da API que está a ser chamada.

Corpo do Pedido

Name	Necessário	Tipo	Description
roles	True	RoleAssignment[]	Lista de atribuições de funções que especificam as permissões para aceder à aplicação.
expiry		string	Data formatada em cadeia que representa a hora em que o token expira.

Respostas

Name	Tipo	Description
200 OK	ApiToken	Com êxito
Other Status Codes	Error	Uma resposta de erro recebida do Serviço 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 a sua conta de utilizador

Exemplos

Create API token

Sample Request

HTTP

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

Status code:

200

{
  "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

Name	Description
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	Tipo	Description
expiry	string	Data formatada em cadeia que representa a hora em que o token expira.
id	string	ID exclusivo do token da API.
roles	RoleAssignment[]	Lista de atribuições de funções que especificam as permissões para aceder à aplicação.
token	string	Valor do token de API.

Error

A definição de erro de resposta.

Name	Tipo	Description
error	ErrorDetails	Detalhes do erro do pedido atual.

ErrorDetails

As informações detalhadas do erro.

Name	Tipo	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	A hora em que o pedido de erro falhou.

RoleAssignment

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

Name	Tipo	Description
organization	string	ID da organização para esta atribuição de função.
role	string	ID da função para esta atribuição de função.