Api Tokens - Create

Servizio:

IoT Central

Versione API:

2022-07-31

Creare un nuovo token API nell'applicazione da usare nell'API pubblica IoT Central. Il valore del token verrà restituito nella risposta e non verrà restituito di nuovo nelle richieste successive.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
baseDomain	path	True	string	Dominio di base per tutte le richieste di servizio Azure IoT Central.
subdomain	path	True	string	Sottodominio dell'applicazione.
tokenId	path	True	string	ID univoco per il token API.
api-version	query	True	string	Versione dell'API chiamata.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
roles	True	RoleAssignment[]	Elenco delle assegnazioni di ruolo che specificano le autorizzazioni per accedere all'applicazione.
expiry		string	Data formattata con stringa che rappresenta l'ora in cui scade il token.

Risposte

Nome	Tipo	Descrizione
200 OK	ApiToken	Operazione riuscita
Other Status Codes	Error	Risposta di errore ricevuta dal servizio IoT Central. Intestazioni x-ms-error-code: string

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Create API token

Esempio di richiesta

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"
    }
  ]
}

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
ApiToken	Definizione del token di accesso all'API.
Error	Definizione dell'errore di risposta.
ErrorDetails	Informazioni dettagliate sull'errore.
RoleAssignment	Definizione dell'assegnazione di ruolo.

ApiToken

Definizione del token di accesso all'API.

Nome	Tipo	Descrizione
expiry	string	Data formattata con stringa che rappresenta l'ora in cui scade il token.
id	string	ID univoco del token API.
roles	RoleAssignment[]	Elenco delle assegnazioni di ruolo che specificano le autorizzazioni per accedere all'applicazione.
token	string	Valore del token API.

Error

Definizione dell'errore di risposta.

Nome	Tipo	Descrizione
error	ErrorDetails	Dettagli degli errori per la richiesta corrente.

ErrorDetails

Informazioni dettagliate sull'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Dettagli del messaggio di errore.
requestId	string	ID di correlazione per la richiesta corrente.
time	string	Ora in cui la richiesta di errore non è riuscita.

RoleAssignment

Definizione dell'assegnazione di ruolo.

Nome	Tipo	Descrizione
organization	string	ID dell'organizzazione per questa assegnazione di ruolo.
role	string	ID del ruolo per questa assegnazione di ruolo.