MImistral
beta.admin.users

Update User

Changed on

Update an Organization member's roles and product seats.

patch/v1/admin/users/{user_id}

Request

Path parameters

user_idstring uuid required

User ID.

Request body

role_namesstring[] nullable

Simplified role names to assign. Mutually exclusive with 'roles'.

role_name'member' | 'billing_manager' | 'organization_admin' nullable

Deprecated single role name, kept for backward compatibility. Mutually exclusive with 'role'.

subscription_typesstring[] nullable

Product seats to assign to the member.

Response

OK

uuidstring uuid required

Organization member ID.

oid_idstring uuid nullable required

Identity provider ID for the member.

namestring nullable required

Name of the Organization member.

emailstring nullable required

Email address of the Organization member.

is_sso_outsiderboolean nullable

Whether the member is outside the SSO domain.

subscription_typesstring[] nullable

Product seats assigned to the member.

created_atstring date-time required

Date the member was added to the Organization.

Example response

{
  "name": "Alice Martin",
  "email": "alice.martin@example.com",
  "workspaces": [
    {
      "name": "Product Team"
    }
  ]
}

Changes

  • 6c349f3bdef6Revision changes
    • warning

      added the new 7e69e493-caf6-4671-af60-84951754d9fc enum value to the //// response property for the response status

    • warning

      added the new 7e69e493-caf6-4671-af60-84951754d9fc enum value to the ///// response property for the response status

    • warning

      added the new 94ef59cf-56bf-4383-9dd6-1fee77d370af enum value to the //// response property for the response status

    • warning

      added the new 94ef59cf-56bf-4383-9dd6-1fee77d370af enum value to the ///// response property for the response status

  • fa73befe1c61Revision changes
    • warning

      added the new 348fc8da-f6da-4464-ad3e-af7bc137e221 enum value to the //// response property for the response status

    • warning

      added the new 348fc8da-f6da-4464-ad3e-af7bc137e221 enum value to the ///// response property for the response status

    • warning

      added the new IC enum value to the /// response property for the response status

    • warning

      added the new PC enum value to the /// response property for the response status