Interroger la liste des organisations

Permet d'interroger la liste des organisations accessibles au compte auquel appartient la clé de développeur actuelle.

Cette interface permet d'interroger la liste des organisations accessibles au compte auquel appartient la clé de développeur actuelle.

Méthode de requête

GET

URL de la requête

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

Authentification de la requête

Utilise l'authentification Basic avec la DevKey / le DevSecret de niveau compte.

Requête

Exemple de requête

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}'

Ce bloc de code dans la fenêtre flottante

En-têtes de la requête

Champ	Type	Description
Authorization	Basic ${BASIC_TOKEN}	Utilisez le Basic Token obtenu en encodant `DevKey:DevSecret` en Base64.

Paramètres de la requête

Aucun.

Réponse

Exemple de réponse

{ "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
    }
  ]
}

Ce bloc de code dans la fenêtre flottante

Réponse en cas de succès

Champ	Type	Description
org_id	String	ID de l'organisation ; ce champ doit être fourni pour les interfaces de ressources d'organisation ultérieures.
org_name	String	Nom de l'organisation.
is_owner	Boolean	Indique si le compte actuel est le propriétaire de l'organisation.

Réponse en cas d'échec

Champ	Type	Description
code	Integer	Code d'erreur.
message	String	Détails de l'erreur.

Codes d'état

Code d'état	Description
200	Succès
400	Erreur de paramètre
401	Non autorisé
403	Autorisation insuffisante
429	Requêtes trop fréquentes
500	Erreur du serveur