Api Tokens - Get

Tjänst:

IoT Central

API-version:

2022-07-31

Hämta en API-token kopplad till ett ID.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
baseDomain	path	True	string	Basdomänen för alla Azure IoT Central-tjänstbegäranden.
subdomain	path	True	string	Programmets underdomän.
tokenId	path	True	string	Unikt ID för API-token.
api-version	query	True	string	Den version av API:et som anropas.

Svar

Name	Typ	Description
200 OK	ApiToken	Klart
Other Status Codes	Error	Ett felsvar som tagits emot från IoT Central-tjänsten. Sidhuvuden x-ms-error-code: string

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Get API token by ID

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
ApiToken	Api-åtkomsttokendefinitionen.
Error	Definitionen av svarsfel.
ErrorDetails	Detaljerad information om felet.
RoleAssignment	Rolltilldelningsdefinitionen.

ApiToken

Api-åtkomsttokendefinitionen.

Name	Typ	Description
expiry	string	Strängformaterat datum som representerar den tid då token upphör att gälla.
id	string	Unikt ID för API-token.
roles	RoleAssignment[]	Lista över rolltilldelningar som anger behörigheter för att komma åt programmet.
token	string	Värdet för API-token.

Error

Definitionen av svarsfel.

Name	Typ	Description
error	ErrorDetails	Felinformation för aktuell begäran.

ErrorDetails

Detaljerad information om felet.

Name	Typ	Description
code	string	Felkod.
message	string	Information om felmeddelanden.
requestId	string	Korrelations-ID för aktuell begäran.
time	string	Den tid då felbegäran misslyckades.

RoleAssignment

Rolltilldelningsdefinitionen.

Name	Typ	Description
organization	string	ID för organisationen för den här rolltilldelningen.
role	string	ID för rollen för den här rolltilldelningen.