Api Tokens - List
Obtener la lista de tokens de API de una aplicación. El valor del token nunca se devolverá por motivos de seguridad.
GET https://{subdomain}.{baseDomain}/api/apiTokens?api-version=2022-07-31
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
base
|
path | True |
string |
Dominio base para todas las solicitudes de servicio de Azure IoT Central. |
subdomain
|
path | True |
string |
Subdominio de aplicación. |
api-version
|
query | True |
string |
Versión de la API a la que se llama. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Correcto |
|
Other Status Codes |
Respuesta de error recibida del servicio IoT Central. Headers x-ms-error-code: string |
Seguridad
azure_auth
Flujo OAuth2 de Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
user_impersonation | suplantación de su cuenta de usuario |
Ejemplos
List API tokens
Sample Request
GET https://appsubdomain.azureiotcentral.com/api/apiTokens?api-version=2022-07-31
Sample Response
{
"value": [
{
"id": "testtoken",
"roles": [
{
"role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
},
{
"role": "c495eb57-eb18-489e-9802-62c474e5645c",
"organization": "seattle"
}
],
"expiry": "2020-10-18T18:30:40.227Z"
}
]
}
Definiciones
Nombre | Description |
---|---|
Api |
Definición del token de acceso de API. |
Api |
Resultados paginados de tokens de API. |
Error |
Definición de error de respuesta. |
Error |
Información detallada del error. |
Role |
Definición de asignación de roles. |
ApiToken
Definición del token de acceso de API.
Nombre | Tipo | Description |
---|---|---|
expiry |
string |
Fecha con formato de cadena que representa la hora en que expira el token. |
id |
string |
Identificador único del token de API. |
roles |
Lista de asignaciones de roles que especifican los permisos para acceder a la aplicación. |
|
token |
string |
Valor del token de API. |
ApiTokenCollection
Resultados paginados de tokens de API.
Nombre | Tipo | Description |
---|---|---|
nextLink |
string |
Dirección URL para obtener la siguiente página de tokens de API. |
value |
Api |
Colección de tokens de API. |
Error
Definición de error de respuesta.
Nombre | Tipo | Description |
---|---|---|
error |
Detalles del error de la solicitud actual. |
ErrorDetails
Información detallada del error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error. |
message |
string |
Detalles del mensaje de error. |
requestId |
string |
Id. de correlación para la solicitud actual. |
time |
string |
La hora en que se produjo un error en la solicitud de error. |
RoleAssignment
Definición de asignación de roles.
Nombre | Tipo | Description |
---|---|---|
organization |
string |
Identificador de la organización para esta asignación de roles. |
role |
string |
Identificador del rol para esta asignación de roles. |