Organizations - Create

Service:

IoT Central

API Version:

2022-07-31

Creación de una organización en la aplicación

PUT https://{subdomain}.{baseDomain}/api/organizations/{organizationId}?api-version=2022-07-31

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
baseDomain	path	True	string	Dominio base para todas las solicitudes de servicio de Azure IoT Central.
organizationId	path	True	string	Identificador único de la organización. Regex pattern: ^(?!-)[a-z0-9-]{1,48}[a-z0-9]$
subdomain	path	True	string	Subdominio de aplicación.
api-version	query	True	string	Versión de la API a la que se llama.

Cuerpo de la solicitud

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la organización.
parent	string	Id. del elemento primario de la organización.

Respuestas

Nombre	Tipo	Description
200 OK	Organization	Correcto
Other Status Codes	Error	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

Add or update organization

Sample Request

HTTP

PUT https://appsubdomain.azureiotcentral.com/api/organizations/seattle?api-version=2022-07-31

{
  "displayName": "Seattle",
  "parent": "washington"
}

Sample Response

Status code:

200

{
  "id": "seattle",
  "displayName": "Seattle",
  "parent": "washington"
}

Definiciones

Nombre	Description
Error	Definición de error de respuesta.
ErrorDetails	Información detallada del error.
Organization	Definición de la organización.

Error

Definición de error de respuesta.

Nombre	Tipo	Description
error	ErrorDetails	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.

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	Id. del elemento primario de la organización.