Api Tokens - Create
Maak een nieuw API-token in de toepassing voor gebruik in de openbare API van IoT Central. De tokenwaarde wordt geretourneerd in het antwoord en wordt niet opnieuw geretourneerd in volgende aanvragen.
PUT https://{subdomain}.{baseDomain}/api/apiTokens/{tokenId}?api-version=2022-07-31
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
base
|
path | True |
string |
Het basisdomein voor alle Azure IoT Central-serviceaanvragen. |
subdomain
|
path | True |
string |
Het subdomein van de toepassing. |
token
|
path | True |
string |
Unieke id voor het API-token. |
api-version
|
query | True |
string |
De versie van de API die wordt aangeroepen. |
Aanvraagbody
Name | Vereist | Type | Description |
---|---|---|---|
roles | True |
Lijst met roltoewijzingen die de machtigingen voor toegang tot de toepassing opgeven. |
|
expiry |
string |
Datum met tekenreeksnotatie die de tijd aangeeft waarop het token verloopt. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
Geslaagd |
|
Other Status Codes |
Een foutbericht ontvangen van de IoT Central-service. Kopteksten x-ms-error-code: string |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | uw gebruikersaccount imiteren |
Voorbeelden
Create API token
Voorbeeldaanvraag
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"
}
]
}
Voorbeeldrespons
{
"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=..."
}
Definities
Name | Description |
---|---|
Api |
De definitie van het API-toegangstoken. |
Error |
De antwoordfoutdefinitie. |
Error |
De gedetailleerde informatie over de fout. |
Role |
De definitie van de roltoewijzing. |
ApiToken
De definitie van het API-toegangstoken.
Name | Type | Description |
---|---|---|
expiry |
string |
Datum met tekenreeksnotatie die de tijd aangeeft waarop het token verloopt. |
id |
string |
Unieke id van het API-token. |
roles |
Lijst met roltoewijzingen die de machtigingen voor toegang tot de toepassing opgeven. |
|
token |
string |
Waarde van het API-token. |
Error
De antwoordfoutdefinitie.
Name | Type | Description |
---|---|---|
error |
Foutdetails voor de huidige aanvraag. |
ErrorDetails
De gedetailleerde informatie over de fout.
Name | Type | Description |
---|---|---|
code |
string |
Foutcode. |
message |
string |
Details van foutbericht. |
requestId |
string |
Correlatie-id voor huidige aanvraag. |
time |
string |
Het tijdstip waarop de foutaanvraag is mislukt. |
RoleAssignment
De definitie van de roltoewijzing.
Name | Type | Description |
---|---|---|
organization |
string |
Id van de organisatie voor deze roltoewijzing. |
role |
string |
Id van de rol voor deze roltoewijzing. |