Organizations - List

Service:

IoT Central

API Version:

2022-07-31

De lijst met organisaties ophalen waar de gebruiker toegang toe heeft in een toepassing

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

URI-parameters

Name	In	Vereist	Type	Description
baseDomain	path	True	string	Het basisdomein voor alle Azure IoT Central-serviceaanvragen.
subdomain	path	True	string	Het subdomein van de toepassing.
api-version	query	True	string	De versie van de API die wordt aangeroepen.

Antwoorden

Name	Type	Description
200 OK	OrganizationCollection	Geslaagd
Other Status Codes	Error	Een foutbericht ontvangen van de IoT Central-service. Headers x-ms-error-code: string

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

List organizations

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "us",
      "displayName": "United States"
    },
    {
      "id": "washington",
      "displayName": "Washington",
      "parent": "us"
    },
    {
      "id": "seattle",
      "displayName": "Seattle",
      "parent": "washington"
    }
  ]
}

Definities

Name	Description
Error	De antwoordfoutdefinitie.
ErrorDetails	De gedetailleerde informatie over de fout.
Organization	De organisatiedefinitie.
OrganizationCollection	De gepaginade resultaten van organisaties.

Error

De antwoordfoutdefinitie.

Name	Type	Description
error	ErrorDetails	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.

Organization

De organisatiedefinitie.

Name	Type	Description
displayName	string	Weergavenaam van de organisatie.
id	string	Unieke id van de organisatie.
parent	string	Id van het bovenliggende item van de organisatie.

OrganizationCollection

De gepaginade resultaten van organisaties.

Name	Type	Description
nextLink	string	URL om de volgende pagina met organisaties op te halen.
value	Organization[]	De verzameling organisaties.