Organizations - List
Obtener la lista de organizaciones a las que el usuario tiene acceso en una aplicación
GET https://{subdomain}.{baseDomain}/api/organizations?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. Encabezados x-ms-error-code: string |
Seguridad
azure_auth
Flujo OAuth2 de Azure Active Directory
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
user_impersonation | suplantación de su cuenta de usuario |
Ejemplos
List organizations
Solicitud de ejemplo
GET https://appsubdomain.azureiotcentral.com/api/organizations?api-version=2022-07-31
Respuesta de muestra
{
"value": [
{
"id": "us",
"displayName": "United States"
},
{
"id": "washington",
"displayName": "Washington",
"parent": "us"
},
{
"id": "seattle",
"displayName": "Seattle",
"parent": "washington"
}
]
}
Definiciones
Nombre | Description |
---|---|
Error |
Definición de error de respuesta. |
Error |
Información detallada del error. |
Organization |
Definición de la organización. |
Organization |
Resultados paginados de las organizaciones. |
Error
Definición de error de respuesta.
Nombre | Tipo | Description |
---|---|---|
error |
Detalles del error para 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 |
Hora en que se produjo un error en la solicitud de error. |
Organization
Definición de la organización.
Nombre | Tipo | Description |
---|---|---|
displayName |
string |
Nombre para mostrar de la organización. |
id |
string |
Identificador único de la organización. |
parent |
string |
Identificador del elemento primario de la organización. |
OrganizationCollection
Resultados paginados de las organizaciones.
Nombre | Tipo | Description |
---|---|---|
nextLink |
string |
Dirección URL para obtener la página siguiente de las organizaciones. |
value |
Colección de organizaciones. |