Api Tokens - Create

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 In Required Type 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 Required Type Description
roles True

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 Type Description
200 OK

Klart

Other Status Codes

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

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

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

ApiToken

Api-åtkomsttokendefinitionen.

Error

Definitionen av svarsfel.

ErrorDetails

Detaljerad information om felet.

RoleAssignment

Rolltilldelningsdefinitionen.

ApiToken

Api-åtkomsttokendefinitionen.

Name Type 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

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 Type Description
error

Felinformation för aktuell begäran.

ErrorDetails

Detaljerad information om felet.

Name Type 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 Type 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.