Skip to main content

Update a user​

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

Manages an existing user. Managing a user includes enabling or disabling the user, changing the user's full name or updating the user's role.

Path Parameters
  • user_id int64 required

    The Clumio-assigned ID of the user to be updated.

Request Body
  • assigned_role string

    Updates the role assigned to the user. The available roles can be retrieved via the GET /roles API.

  • full_name string

    The full name of the user that is to replace the existing full name. For example, enter the user's first name and last name.

  • is_enabled boolean

    If true, enables a user who has been disabled from Clumio, returning the user to its previous "Activated" or "Invited" status. If false, disables a user from Clumio. The user will not be able log in to Clumio until another Clumio user re-enables the account.

  • organizational_unit_assignment_updates object

    Updates to the organizational unit assignments.

  • add string[]

    The Clumio-assigned IDs of the organizational units to be assigned to the user.

  • remove string[]

    The Clumio-assigned IDs of the organizational units to be unassigned to the user.

Responses

Success

Schema
  • _embedded object

    Embedded responses related to the resource.

  • description string

    A description of the role.

  • name string

    Unique name assigned to the role.

  • _links object

    URLs to pages related to the resource.

  • _self object

    The HATEOAS link to this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • delete-user object

    A resource-specific HATEOAS link.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • update-user object

    A resource-specific HATEOAS link.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • assigned_organizational_unit_ids string[]

    The list of organizational unit IDs assigned to the user. This attribute will be available when reading a single user and not when listing users.

  • assigned_role string

    Assigned Role for the user.

  • email string

    The email address of the Clumio user.

  • full_name string

    The first and last name of the Clumio user. The name appears in the User Management screen and is used to identify the user.

  • id string

    The Clumio-assigned ID of the Clumio user.

  • inviter string

    The ID number of the user who sent the email invitation.

  • is_confirmed boolean

    Determines whether the user has activated their Clumio account. If true, the user has activated the account.

  • is_enabled boolean

    Determines whether the user is enabled (in "Activated" or "Invited" status) in Clumio. If true, the user is in "Activated" or "Invited" status in Clumio. Users in "Activated" status can log in to Clumio. Users in "Invited" status have been invited to log in to Clumio via an email invitation and the invitation is pending acceptance from the user. If false, the user has been manually suspended and cannot log in to Clumio until another Clumio user reactivates the account.

  • last_activity_timestamp string

    The timestamp of when the user was last active in the Clumio system. Represented in RFC-3339 format.

  • organizational_unit_count int64

    The number of organizational units accessible to the user.

Loading...