Groupes d'utilisateurs Admin Bêta

(Beta) API Admin - gestion des groupes d'utilisateurs. Requiert une clé API admin.

Récupérer les groupes d'utilisateurs

GET /v1/admin/user-groups#

Récupérer tous les groupes d'utilisateurs de l'organisation.

200

items#

*array<AdminUserGroupOut>

Groupes d'utilisateurs sur cette page.

page#

*integer

Numéro de page renvoyé.

page_size#

*integer

Nombre maximum de résultats par page.

total#

*integer

Nombre total de groupes d'utilisateurs correspondant à la requête.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/admin/user-groups \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

curl https://api.mistral.ai/v1/admin/user-groups \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

{
  "items": [
    {
      "description": null,
      "name": "Engineering Team",
      "uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
    }
  ],
  "page": "1",
  "page_size": "1000",
  "total": 56
}

{
  "items": [
    {
      "description": null,
      "name": "Engineering Team",
      "uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
    }
  ],
  "page": "1",
  "page_size": "1000",
  "total": 56
}

Créer un groupe d'utilisateurs

POST /v1/admin/user-groups#

Créer un nouveau groupe d'utilisateurs.

200

description#

*string|null

Description optionnelle du groupe d'utilisateurs.

externally_managed#

boolean|null

Indique si le groupe est géré par un système externe.

name#

*string

Nom du groupe d'utilisateurs.

organization_role#

string|null

Rôle d'organisation attribué au groupe.

target_type#

"W"|"O"

Type de ressources auxquelles ce groupe peut accéder.

uuid#

*string

Identifiant du groupe d'utilisateurs.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/admin/user-groups \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "name": "Engineering Team"
}'

curl https://api.mistral.ai/v1/admin/user-groups \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "name": "Engineering Team"
}'

200

{
  "description": null,
  "name": "Engineering Team",
  "uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}

{
  "description": null,
  "name": "Engineering Team",
  "uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}

Provisionner un groupe vers un espace de travail

POST /v1/admin/user-groups/provision-workspace#

Provisionner tous les utilisateurs d'un groupe d'utilisateurs à un espace de travail avec un rôle spécifique.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/admin/user-groups/provision-workspace \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "user_group_uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088",
  "workspace_uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}'

curl https://api.mistral.ai/v1/admin/user-groups/provision-workspace \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "user_group_uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088",
  "workspace_uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}'

Récupérer un groupe d'utilisateurs

GET /v1/admin/user-groups/{group_uuid}#

Récupérer un groupe d'utilisateurs spécifique.

200

description#

*string|null

Description optionnelle du groupe d'utilisateurs.

externally_managed#

boolean|null

Indique si le groupe est géré par un système externe.

name#

*string

Nom du groupe d'utilisateurs.

organization_role#

string|null

Rôle d'organisation attribué au groupe.

target_type#

"W"|"O"

Type de ressources auxquelles ce groupe peut accéder.

uuid#

*string

Identifiant du groupe d'utilisateurs.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid} \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid} \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

{
  "description": null,
  "name": "Engineering Team",
  "uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}

{
  "description": null,
  "name": "Engineering Team",
  "uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}

Supprimer un groupe d'utilisateurs

DELETE /v1/admin/user-groups/{group_uuid}#

Supprimer un groupe d'utilisateurs.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid} \
 -X DELETE \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json'

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid} \
 -X DELETE \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json'

Mettre à jour un groupe d'utilisateurs

PATCH /v1/admin/user-groups/{group_uuid}#

Mettre à jour un groupe d'utilisateurs.

200

description#

*string|null

Description optionnelle du groupe d'utilisateurs.

externally_managed#

boolean|null

Indique si le groupe est géré par un système externe.

name#

*string

Nom du groupe d'utilisateurs.

organization_role#

string|null

Rôle d'organisation attribué au groupe.

target_type#

"W"|"O"

Type de ressources auxquelles ce groupe peut accéder.

uuid#

*string

Identifiant du groupe d'utilisateurs.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid} \
 -X PATCH \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{}'

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid} \
 -X PATCH \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{}'

200

{
  "description": null,
  "name": "Engineering Team",
  "uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}

{
  "description": null,
  "name": "Engineering Team",
  "uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}

Récupérer les membres d'un groupe d'utilisateurs

GET /v1/admin/user-groups/{group_uuid}/members#

Récupérer les membres d'un groupe d'utilisateurs.

200

members#

*array<AdminUserGroupMemberOut>

Membres du groupe sur cette page.

page#

*integer

Numéro de page renvoyé.

page_size#

*integer

Nombre maximum de résultats par page.

total#

*integer

Nombre total de membres du groupe correspondant à la requête.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid}/members \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid}/members \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

{
  "members": [
    {
      "email": null,
      "name": null,
      "user_uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
    }
  ],
  "page": "1",
  "page_size": "1000",
  "total": 56
}

{
  "members": [
    {
      "email": null,
      "name": null,
      "user_uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
    }
  ],
  "page": "1",
  "page_size": "1000",
  "total": 56
}

Assigner des utilisateurs à un groupe

POST /v1/admin/user-groups/{group_uuid}/members#

Assigner des utilisateurs à un groupe d'utilisateurs.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid}/members \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "user_uuids": [
    "019b2bd7-96e7-7219-8c0b-45a73da50088"
  ]
}'

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid}/members \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "user_uuids": [
    "019b2bd7-96e7-7219-8c0b-45a73da50088"
  ]
}'

Retirer des utilisateurs du groupe

DELETE /v1/admin/user-groups/{group_uuid}/members#

Retirer des utilisateurs d'un groupe d'utilisateurs.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid}/members \
 -X DELETE \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "user_uuids": [
    "019b2bd7-96e7-7219-8c0b-45a73da50088"
  ]
}'

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid}/members \
 -X DELETE \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "user_uuids": [
    "019b2bd7-96e7-7219-8c0b-45a73da50088"
  ]
}'

Récupérer les affectations d'espaces de travail du groupe

GET /v1/admin/user-groups/{group_uuid}/workspaces#

Lister les affectations d'espaces de travail pour un groupe d'utilisateurs.

200

items#

*array<GroupWorkspaceAssignmentOut>

Attributions d'espaces de travail sur cette page.

page#

*integer

Numéro de page renvoyé.

page_size#

*integer

Nombre maximum de résultats par page.

total#

*integer

Nombre total d'attributions d'espaces de travail correspondant à la requête.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid}/workspaces \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid}/workspaces \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

{
  "items": [
    {
      "created": "2025-10-07T20:56:01.974Z",
      "roles": [
        {
          "name": "My resource",
          "uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
        }
      ],
      "workspace_name": "Product Team",
      "workspace_uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
    }
  ],
  "page": "1",
  "page_size": "1000",
  "total": 56
}

{
  "items": [
    {
      "created": "2025-10-07T20:56:01.974Z",
      "roles": [
        {
          "name": "My resource",
          "uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
        }
      ],
      "workspace_name": "Product Team",
      "workspace_uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
    }
  ],
  "page": "1",
  "page_size": "1000",
  "total": 56
}

Assigner un groupe à un espace de travail

POST /v1/admin/user-groups/{group_uuid}/workspaces#

Assigner un groupe d'utilisateurs à un espace de travail.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid}/workspaces \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "workspace_uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}'

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid}/workspaces \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "workspace_uuid": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}'

Retirer un groupe de l'espace de travail

DELETE /v1/admin/user-groups/{group_uuid}/workspaces/{workspace_uuid}#

Retirer un groupe d'utilisateurs d'un espace de travail.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid}/workspaces/{workspace_uuid} \
 -X DELETE \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json'

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid}/workspaces/{workspace_uuid} \
 -X DELETE \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json'

Mettre à jour l'affectation d'espace de travail du groupe

PATCH /v1/admin/user-groups/{group_uuid}/workspaces/{workspace_uuid}#

Mettre à jour l'affectation de rôle d'espace de travail pour un groupe d'utilisateurs.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid}/workspaces/{workspace_uuid} \
 -X PATCH \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{}'

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid}/workspaces/{workspace_uuid} \
 -X PATCH \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{}'

Mettre à jour le rôle d'organisation du groupe d'utilisateurs

PATCH /v1/admin/user-groups/{group_uuid}/organization-role#

Mettre à jour le rôle d'organisation d'un groupe d'utilisateurs.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid}/organization-role \
 -X PATCH \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "organization_role": "A"
}'

curl https://api.mistral.ai/v1/admin/user-groups/{group_uuid}/organization-role \
 -X PATCH \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "organization_role": "A"
}'

Groupes d'utilisateurs Admin Bêta

Exemples

GET /v1/admin/user-groups#

Security#

AdminApiKey#

Parameters#

page#

page_size#

search#

items#

page#

page_size#

total#

Playground

POST /v1/admin/user-groups#

Security#

AdminApiKey#

Request Body#

description#

name#

target_type#

description#

externally_managed#

name#

organization_role#

target_type#

uuid#

Playground

POST /v1/admin/user-groups/provision-workspace#

Security#

AdminApiKey#

Request Body#

user_group_uuid#

workspace_role#

workspace_role_name#

workspace_uuid#

Playground

GET /v1/admin/user-groups/{group_uuid}#

Security#

AdminApiKey#

Parameters#

group_uuid#

description#

externally_managed#

name#

organization_role#

target_type#

uuid#

Playground

DELETE /v1/admin/user-groups/{group_uuid}#

Security#

AdminApiKey#

Parameters#

group_uuid#

Playground

PATCH /v1/admin/user-groups/{group_uuid}#

Security#

AdminApiKey#

Parameters#

group_uuid#

Request Body#

description#

name#

target_type#

description#

externally_managed#

name#

organization_role#

target_type#

uuid#

Playground

GET /v1/admin/user-groups/{group_uuid}/members#

Security#

AdminApiKey#

Parameters#

group_uuid#

page#

page_size#

members#

page#