API des équipes
Gérez les équipes et leurs membres. Les requêtes restent soumises aux autorisations de votre compte et de votre équipe.
Utiliser Authentification API pour les requêtes protégées. Les exemples utilisent vos propres ID de ressources et un jeton temporaire ; les exemples de réponses enregistrés sont synthétiques.
| Méthode | Chemin | Opération |
|---|---|---|
GET | /v1/team | Lister les équipes |
POST | /v1/team | Créer une équipe |
GET | /v1/team/{id} | Obtenir l’équipe |
PUT | /v1/team/{id} | Mettre à jour l’équipe |
DELETE | /v1/team/{id} | Supprimer l'équipe |
GET | /v1/team/deployment-context | Obtenir le contexte de déploiement |
GET | /v1/team/members | Lister les membres de l’équipe |
GET | /v1/team/invitations | Lister les invitations de l’équipe |
POST | /v1/team/invitations | Inviter un membre de l'équipe |
POST | /v1/team/invitations/{id}/resend | Renvoyer l’invitation de l’équipe |
DELETE | /v1/team/invitations/{id} | Révoquer l’invitation de l’équipe |
Lister les équipes
GET /v1/team
Renvoie une liste paginée de Team
Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
X-Tenant-ID | en-tête | oui | ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic. |
page | requête | non | Numéro de page |
per_page | requête | non | Éléments par page |
Exemple de requête
Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.
curl --fail-with-body --request GET "$ADIOS_API_URL/v1/team" \
-H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
-H "X-Tenant-ID: $ADIOS_TEAM_ID"
Réponse : HTTP 200
Liste de Team
Champs de réponse
| Champ | Type | Description |
|---|---|---|
data | tableau | |
data[].created_at | entier | (horodatage Unix) |
data[].deleted_at | entier | (horodatage Unix) |
data[].description | chaîne | |
data[].owner_id | chaîne | |
data[].parent_id | chaîne | |
data[].status | chaîne | Valeurs autorisées : active, inactive, suspended, deleted. |
data[].team_id | chaîne | |
data[].title | chaîne | |
data[].updated_at | entier | (horodatage Unix) |
pagination | objet | |
pagination.page | entier | Numéro de page actuel |
pagination.per_page | entier | Nombre d’éléments par page |
pagination.total | entier | Nombre total d’éléments |
Exemple illustratif ; il ne s’agit pas d’une réponse réelle :
{
"data": [
{
"created_at": 1791072000,
"deleted_at": 0,
"description": "",
"owner_id": "000000000000000000000000001",
"parent_id": "000000000000000000000000001",
"status": "active",
"team_id": "000000000000000000000000001",
"title": "Postman example",
"updated_at": 1791072000
}
],
"pagination": {
"page": 1,
"per_page": 1,
"total": 1
}
}
Créer une équipe
POST /v1/team
Crée un nouvel objet Team
Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.
Champs de la requête (le corps contient un exemple modifiable) :
| Champ | Type | Requis | Description |
|---|---|---|---|
description | chaîne | non | Valeur par défaut : "". |
owner_id | chaîne | oui | |
parent_id | chaîne | non | |
status | chaîne | oui | Valeurs autorisées : active, inactive, suspended, deleted. Valeur par défaut : "active". |
title | chaîne | oui |
Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
X-Tenant-ID | en-tête | oui | ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic. |
Exemple de requête
Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.
curl --fail-with-body --request POST "$ADIOS_API_URL/v1/team" \
-H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
-H "X-Tenant-ID: $ADIOS_TEAM_ID" \
-H "Content-Type: application/json" \
--data-binary @- <<'JSON'
{
"owner_id": "YOUR_USER_ID",
"title": "Postman example team",
"status": "active"
}
JSON
Remplacez YOUR_* du corps avant l’envoi. Le heredoc entre guillemets préserve le JSON littéral.
Réponse : HTTP 201
Équipe créée
Champs de réponse
| Champ | Type | Description |
|---|---|---|
created_at | entier | (horodatage Unix) |
deleted_at | entier | (horodatage Unix) |
description | chaîne | |
owner_id | chaîne | |
parent_id | chaîne | |
status | chaîne | Valeurs autorisées : active, inactive, suspended, deleted. |
team_id | chaîne | |
title | chaîne | |
updated_at | entier | (horodatage Unix) |
Exemple illustratif ; il ne s’agit pas d’une réponse réelle :
{
"created_at": 1791072000,
"deleted_at": 0,
"description": "",
"owner_id": "000000000000000000000000001",
"parent_id": "000000000000000000000000001",
"status": "active",
"team_id": "000000000000000000000000001",
"title": "Postman example",
"updated_at": 1791072000
}
Obtenir l’équipe
GET /v1/team/{id}
Renvoie un seul Team
Définissez team_id en utilisant les ID de vos propres réponses API.
Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic. |
Exemple de requête
Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.
curl --fail-with-body --request GET "$ADIOS_API_URL/v1/team/${ADIOS_TEAM_ID}" \
-H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
-H "X-Tenant-ID: $ADIOS_TEAM_ID"
Réponse : HTTP 200
Équipe
Champs de réponse
| Champ | Type | Description |
|---|---|---|
created_at | entier | (horodatage Unix) |
deleted_at | entier | (horodatage Unix) |
description | chaîne | |
owner_id | chaîne | |
parent_id | chaîne | |
status | chaîne | Valeurs autorisées : active, inactive, suspended, deleted. |
team_id | chaîne | |
title | chaîne | |
updated_at | entier | (horodatage Unix) |
Exemple illustratif ; il ne s’agit pas d’une réponse réelle :
{
"created_at": 1791072000,
"deleted_at": 0,
"description": "",
"owner_id": "000000000000000000000000001",
"parent_id": "000000000000000000000000001",
"status": "active",
"team_id": "000000000000000000000000001",
"title": "Postman example",
"updated_at": 1791072000
}
Mettre à jour l’équipe
PUT /v1/team/{id}
Met à jour un objet Team existant
Définissez team_id en utilisant les ID de vos propres réponses API.
Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.
Champs de la requête (le corps contient un exemple modifiable) :
| Champ | Type | Requis | Description |
|---|---|---|---|
description | chaîne | non | Valeur par défaut : "". |
owner_id | chaîne | oui | |
parent_id | chaîne | non | |
status | chaîne | oui | Valeurs autorisées : active, inactive, suspended, deleted. Valeur par défaut : "active". |
title | chaîne | oui |
Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic. |
Exemple de requête
Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.
curl --fail-with-body --request PUT "$ADIOS_API_URL/v1/team/${ADIOS_TEAM_ID}" \
-H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
-H "X-Tenant-ID: $ADIOS_TEAM_ID" \
-H "Content-Type: application/json" \
--data-binary @- <<'JSON'
{
"owner_id": "YOUR_USER_ID",
"title": "Postman example team",
"status": "active"
}
JSON
Remplacez YOUR_* du corps avant l’envoi. Le heredoc entre guillemets préserve le JSON littéral.
Réponse : HTTP 200
Équipe mise à jour
Champs de réponse
| Champ | Type | Description |
|---|---|---|
created_at | entier | (horodatage Unix) |
deleted_at | entier | (horodatage Unix) |
description | chaîne | |
owner_id | chaîne | |
parent_id | chaîne | |
status | chaîne | Valeurs autorisées : active, inactive, suspended, deleted. |
team_id | chaîne | |
title | chaîne | |
updated_at | entier | (horodatage Unix) |
Exemple illustratif ; il ne s’agit pas d’une réponse réelle :
{
"created_at": 1791072000,
"deleted_at": 0,
"description": "",
"owner_id": "000000000000000000000000001",
"parent_id": "000000000000000000000000001",
"status": "active",
"team_id": "000000000000000000000000001",
"title": "Postman example",
"updated_at": 1791072000
}
Supprimer l'équipe
DELETE /v1/team/{id}
Supprime un objet Team
Définissez team_id en utilisant les ID de vos propres réponses API.
Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.
Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic. |
Exemple de requête
Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.
curl --fail-with-body --request DELETE "$ADIOS_API_URL/v1/team/${ADIOS_TEAM_ID}" \
-H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
-H "X-Tenant-ID: $ADIOS_TEAM_ID"
Réponse : HTTP 200
Ressource supprimée.
Champs de réponse
| Champ | Type | Description |
|---|---|---|
message | chaîne |
Exemple illustratif ; il ne s’agit pas d’une réponse réelle :
{
"message": "Deleted successfully"
}
Obtenir le contexte de déploiement
GET /v1/team/deployment-context
Découvrez les régions de déploiement disponibles et le contexte de déploiement actif de l'équipe.
Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
X-Tenant-ID | en-tête | oui | ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic. |
Exemple de requête
Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.
curl --fail-with-body --request GET "$ADIOS_API_URL/v1/team/deployment-context" \
-H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
-H "X-Tenant-ID: $ADIOS_TEAM_ID"
Réponse : HTTP 200
Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.
Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.
Lister les membres de l’équipe
GET /v1/team/members
Lister les membres de l'équipe sélectionnée.
Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
X-Tenant-ID | en-tête | oui | ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic. |
Exemple de requête
Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.
curl --fail-with-body --request GET "$ADIOS_API_URL/v1/team/members" \
-H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
-H "X-Tenant-ID: $ADIOS_TEAM_ID"
Réponse : HTTP 200
Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.
Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.
Lister les invitations de l’équipe
GET /v1/team/invitations
Lister les invitations pour l'équipe sélectionnée.
Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
X-Tenant-ID | en-tête | oui | ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic. |
Exemple de requête
Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.
curl --fail-with-body --request GET "$ADIOS_API_URL/v1/team/invitations" \
-H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
-H "X-Tenant-ID: $ADIOS_TEAM_ID"
Réponse : HTTP 200
Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.
Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.
Inviter un membre de l'équipe
POST /v1/team/invitations
Envoyez une invitation par e-mail pour rejoindre l’équipe sélectionnée. role prend en charge user, manager ou team_admin.
Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.
Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
X-Tenant-ID | en-tête | oui | ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic. |
Exemple de requête
Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.
curl --fail-with-body --request POST "$ADIOS_API_URL/v1/team/invitations" \
-H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
-H "X-Tenant-ID: $ADIOS_TEAM_ID" \
-H "Content-Type: application/json" \
--data-binary @- <<'JSON'
{
"email": "YOUR_INVITE_EMAIL",
"role": "user"
}
JSON
Remplacez YOUR_* du corps avant l’envoi. Le heredoc entre guillemets préserve le JSON littéral.
Réponse : HTTP 200
Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.
Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.
Renvoyer l’invitation de l’équipe
POST /v1/team/invitations/{id}/resend
Envoyez à nouveau l'email d'invitation.
Définissez invitation_id en utilisant les ID de vos propres réponses API.
Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.
Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic. |
Exemple de requête
Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.
curl --fail-with-body --request POST "$ADIOS_API_URL/v1/team/invitations/${ADIOS_INVITATION_ID}/resend" \
-H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
-H "X-Tenant-ID: $ADIOS_TEAM_ID"
Réponse : HTTP 200
Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.
Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.
Révoquer l’invitation de l’équipe
DELETE /v1/team/invitations/{id}
Révoquer une invitation en attente.
Définissez invitation_id en utilisant les ID de vos propres réponses API.
Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.
Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic. |
Exemple de requête
Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.
curl --fail-with-body --request DELETE "$ADIOS_API_URL/v1/team/invitations/${ADIOS_INVITATION_ID}" \
-H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
-H "X-Tenant-ID: $ADIOS_TEAM_ID"
Réponse : HTTP 200
Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.
Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.