Organisationsliste abrufen

Ermöglicht das Abrufen der Organisationsliste, auf die das Konto des aktuellen Entwicklerschlüssels zugreifen kann.

Über diese Schnittstelle können Sie die Organisationsliste abrufen, auf die das Konto des aktuellen Entwicklerschlüssels zugreifen kann.

Anfragemethode

GET

Anfrage-URL

https://api.${endpoint}/v1/org/list

Authentifizierung der Anfrage

Basic-Authentifizierung mit DevKey / DevSecret auf Kontoebene.

Anfrage

Beispielanfrage

curl -X GET 'https://api.${endpoint}/v1/org/list' \ -H 'Authorization: Basic ${BASIC_TOKEN}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/org/list' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

Dieser Codeblock im schwebenden Fenster

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Basic ${BASIC_TOKEN}	Basic Token als Base64-Kodierung von `DevKey:DevSecret`.

Anfrageparameter

Keine.

Antwort

Beispielantwort

{ "code": 0, "message": "OK", "data": [ { "org_id": "p-xxxx", "org_name": "Demo Org", "is_owner": true } ] }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": [
    {
      "org_id": "p-xxxx",
      "org_name": "Demo Org",
      "is_owner": true
    }
  ]
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Feld	Typ	Beschreibung
org_id	String	Organisations-ID; muss bei nachfolgenden Schnittstellen für Organisationsressourcen übergeben werden.
org_name	String	Organisationsname.
is_owner	Boolean	Ob das aktuelle Konto Eigentümer der Organisation ist.

Fehlerantwort

Feld	Typ	Beschreibung
code	Integer	Fehlercode.
message	String	Fehlerdetails.

Statuscodes

Statuscode	Beschreibung
200	Erfolgreich
400	Ungültige Parameter
401	Nicht autorisiert
403	Unzureichende Berechtigungen
429	Zu viele Anfragen
500	Serverfehler