Points de terminaison des groupes d'utilisateurs Admin Beta

Gérer les groupes d'utilisateurs et les appartenenances aux groupes.

Récupérer les groupes d'utilisateurs

GET /api/admin/user-groups

Récupère tous les groupes d'utilisateurs dans l'organisation.

200

items

*array<AdminUserGroupOut>

Groupes d'utilisateurs sur cette page.

page

*integer

Numéro de page retourné.

page_size

*integer

Nombre maximum de résultats par page.

total

*integer

Nombre total de groupes d'utilisateurs correspondant à la demande.

Playground

Testez les endpoints en direct

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

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

200

{
  "items": [
    {
      "description": null,
      "name": "ipsum eiusmod",
      "uuid": "consequat do"
    }
  ],
  "page": 87,
  "page_size": 14,
  "total": 56
}

{
  "items": [
    {
      "description": null,
      "name": "ipsum eiusmod",
      "uuid": "consequat do"
    }
  ],
  "page": 87,
  "page_size": 14,
  "total": 56
}

Créer un groupe d'utilisateurs

POST /api/admin/user-groups

Crée un nouveau groupe d'utilisateurs.

200

description

*string|null

Description facultative 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 organisationnel attribué au groupe.

target_type

"W"|"O"

Type de ressources auquel ce groupe peut accéder.

uuid

*string

ID du groupe d'utilisateurs.

Playground

Testez les endpoints en direct

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

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

200

{
  "description": null,
  "name": "ipsum eiusmod",
  "uuid": "consequat do"
}

{
  "description": null,
  "name": "ipsum eiusmod",
  "uuid": "consequat do"
}

Approvisionner un groupe dans un espace de travail

POST /api/admin/user-groups/provision-workspace

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

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/api/admin/user-groups/provision-workspace \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "user_group_uuid": "ipsum eiusmod",
  "workspace_uuid": "consequat do"
}'

curl https://api.mistral.ai/api/admin/user-groups/provision-workspace \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "user_group_uuid": "ipsum eiusmod",
  "workspace_uuid": "consequat do"
}'

Récupérer un groupe d'utilisateurs

GET /api/admin/user-groups/{group_uuid}

Récupère un groupe d'utilisateurs spécifique.

200

description

*string|null

Description facultative 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 organisationnel attribué au groupe.

target_type

"W"|"O"

Type de ressources auxquelles ce groupe peut accéder.

uuid

*string

ID du groupe d'utilisateurs.

Playground

Testez les endpoints en direct

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

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

200

{
  "description": null,
  "name": "ipsum eiusmod",
  "uuid": "consequat do"
}

{
  "description": null,
  "name": "ipsum eiusmod",
  "uuid": "consequat do"
}

Supprimer un groupe d'utilisateurs

DELETE /api/admin/user-groups/{group_uuid}

Supprime un groupe d'utilisateurs.

Playground

Testez les endpoints en direct

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

curl https://api.mistral.ai/api/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 /api/admin/user-groups/{group_uuid}

Met à jour un groupe d'utilisateurs.

200

description

*string|null

Description facultative 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 organisationnel attribué au groupe.

target_type

"W"|"O"

Type de ressources auquel ce groupe peut accéder.

uuid

*string

ID du groupe d'utilisateurs.

Playground

Testez les endpoints en direct

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

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

200

{
  "description": null,
  "name": "ipsum eiusmod",
  "uuid": "consequat do"
}

{
  "description": null,
  "name": "ipsum eiusmod",
  "uuid": "consequat do"
}

Obtenir les membres d’un groupe

GET /api/admin/user-groups/{group_uuid}/members

Récupère les membres d’un groupe d’utilisateurs.

200

membres

*array<AdminUserGroupMemberOut>

Membres du groupe sur cette page.

page

*integer

Numéro de la page retournée.

page_size

*integer

Nombre maximal 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/api/admin/user-groups/{group_uuid}/members \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

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

200

{
  "members": [
    {
      "email": null,
      "name": null,
      "user_uuid": "ipsum eiusmod"
    }
  ],
  "page": 87,
  "page_size": 14,
  "total": 56
}

{
  "members": [
    {
      "email": null,
      "name": null,
      "user_uuid": "ipsum eiusmod"
    }
  ],
  "page": 87,
  "page_size": 14,
  "total": 56
}

Affecter des utilisateurs à un groupe

POST /api/admin/user-groups/{group_uuid}/members

Affecte des utilisateurs à un groupe d’utilisateurs.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/api/admin/user-groups/{group_uuid}/members \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "user_uuids": [
    "ipsum eiusmod"
  ]
}'

curl https://api.mistral.ai/api/admin/user-groups/{group_uuid}/members \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "user_uuids": [
    "ipsum eiusmod"
  ]
}'

Retirer des utilisateurs d’un groupe

DELETE /api/admin/user-groups/{group_uuid}/members

Retire des utilisateurs d’un groupe d’utilisateurs.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/api/admin/user-groups/{group_uuid}/members \
 -X DELETE \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "user_uuids": [
    "ipsum eiusmod"
  ]
}'

curl https://api.mistral.ai/api/admin/user-groups/{group_uuid}/members \
 -X DELETE \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "user_uuids": [
    "ipsum eiusmod"
  ]
}'

Obtenir les affectations d’espaces de travail d’un groupe

GET /api/admin/user-groups/{group_uuid}/workspaces

Liste les affectations d’espaces de travail pour un groupe d’utilisateurs.

200

items

*array<GroupWorkspaceAssignmentOut>

Affectations d’espaces de travail sur cette page.

page

*integer

Numéro de la page retournée.

page_size

*integer

Nombre maximal de résultats par page.

total

*integer

Nombre total d’affectations d’espaces de travail correspondant à la requête.

Playground

Testez les endpoints en direct

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

curl https://api.mistral.ai/api/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": "ipsum eiusmod",
          "uuid": "consequat do"
        }
      ],
      "workspace_name": "reprehenderit ut dolore",
      "workspace_uuid": "occaecat dolor sit"
    }
  ],
  "page": 87,
  "page_size": 14,
  "total": 56
}

{
  "items": [
    {
      "created": "2025-10-07T20:56:01.974Z",
      "roles": [
        {
          "name": "ipsum eiusmod",
          "uuid": "consequat do"
        }
      ],
      "workspace_name": "reprehenderit ut dolore",
      "workspace_uuid": "occaecat dolor sit"
    }
  ],
  "page": 87,
  "page_size": 14,
  "total": 56
}

Affecter un groupe à un espace de travail

POST /api/admin/user-groups/{group_uuid}/workspaces

Affecte un groupe d’utilisateurs à un espace de travail.

Playground

Testez les endpoints en direct

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

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

Retirer un groupe d’un espace de travail

DELETE /api/admin/user-groups/{group_uuid}/workspaces/{workspace_uuid}

Retire un groupe d’utilisateurs d’un espace de travail.

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/api/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/api/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’un groupe à un espace de travail

PATCH /api/admin/user-groups/{group_uuid}/workspaces/{workspace_uuid}

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

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/api/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/api/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 organisationnel d’un groupe d’utilisateurs

PATCH /api/admin/user-groups/{group_uuid}/organization-role

Met à jour le rôle organisationnel pour un groupe d’utilisateurs.

Playground

Testez les endpoints en direct

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

Points de terminaison des groupes d'utilisateurs Admin Beta

Exemples

GET /api/admin/user-groups

Sécurité

AdminApiKey

Paramètres

page

page_size

search

items

page

page_size

total

Playground

POST /api/admin/user-groups

Sécurité

AdminApiKey

Corps de la requête

description

name

target_type

description

externally_managed

name

organization_role

target_type

uuid

Playground

POST /api/admin/user-groups/provision-workspace

Sécurité

AdminApiKey

Corps de la requête

user_group_uuid

workspace_role

workspace_role_name

workspace_uuid

Playground

GET /api/admin/user-groups/{group_uuid}

Sécurité

AdminApiKey

Paramètres

group_uuid

description

externally_managed

name

organization_role

target_type

uuid

Playground

DELETE /api/admin/user-groups/{group_uuid}

Sécurité

AdminApiKey

Paramètres

group_uuid

Playground

PATCH /api/admin/user-groups/{group_uuid}

Sécurité

AdminApiKey

Paramètres

group_uuid

Corps de la requête

description

name

target_type

description

externally_managed

name

organization_role

target_type

uuid

Playground

GET /api/admin/user-groups/{group_uuid}/members

Sécurité

AdminApiKey

Paramètres

group_uuid

page

page_size

membres

page