Api Tokens - Get

Servizio:

IoT Central

Versione API:

2022-07-31

Ottenere un token API in base all'ID.

GET 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 del 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.

Risposte

Nome	Tipo	Descrizione
200 OK	ApiToken	Successo
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

Get API token by ID

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

200

{
  "id": "testtoken",
  "roles": [
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ],
  "expiry": "2020-10-18T18:30:40.227Z"
}

Definizioni

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

ApiToken

Object

Definizione del token di accesso api.

Nome	Tipo	Descrizione
expiry	string (date-time)	Data in formato stringa che rappresenta l'ora di scadenza del token.
id	string	ID univoco del token API.
roles	RoleAssignment[]	Elenco di assegnazioni di ruolo che specificano le autorizzazioni per accedere all'applicazione.
token	string	Valore del token API.

Error

Object

Definizione dell'errore di risposta.

Nome	Tipo	Descrizione
error	ErrorDetails	Dettagli dell'errore per la richiesta corrente.

ErrorDetails

Object

Informazioni dettagliate sull'errore.

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

RoleAssignment

Object

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.