Api Tokens - Create

Service:

IoT Central

API Version:

2022-07-31

Skapa en ny API-token i programmet som ska användas i det offentliga API:et för IoT Central. Tokenvärdet returneras i svaret och returneras inte igen i efterföljande begäranden.

PUT 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.

Begärandetext

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

Svar

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

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

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.