Create a user

Creates a new user. Specify the user's full name and email address to generate an email message that is sent to the user with an invitation to activate their Clumio account.

application/json

Request Body

access_control_configuration object[]
List of Clumio-assigned IDs of the organizational units along with the Clumio-assigned ID of the role to assign to the user.
organizational_unit_ids string[] required
The Clumio-assigned IDs of the organizational units assigned to the user. Use the GET /organizational-units endpoint to fetch valid values.
role_id uuid4
The Clumio-assigned ID of the role assigned to the user. Use the GET /roles endpoint to fetch valid values.
email string required
The email address of the user to be added to Clumio.
full_name string required
The full name of the user to be added to Clumio. For example, type the user's first name and last name. The name displays on the User Management screen and in the body of the email invitation.

Responses

200
default

Success

application/api.clumio.users=v2+json

Schema
Example (from schema)

Schema

_embedded object

Embedded responses related to the resource.

read-role object[]

Embeds the associated Role details in the response

description string

A description of the role.

id string

The Clumio-assigned ID of the role.

name string

Unique name assigned to the role.

permissions object[]

Permissions contained in the role.

description string

Description of the permission.

id string

The Clumio-assigned ID of the permission.

name string

Name of the permission. The following table lists the supported permissions for a role:

Permission Name	Full/Partial Applicable
Policy Management	Yes
Data Source Management	Yes
Perform Backup (Scheduled or On-demand)	Yes
Regular Restore	No
Redirected Granular Restore (things like GRR & content download)	Yes
Dashboards & Reports	Yes
Some Admin Functions (User mgmt, SSO/MFA, IP Allow, Password expiry, OU, KMS)	No
Other Admin Functions (API Tokens, Tasks, Alerts and Audit Logs)	Yes

user_count int64

Number of users to whom the role has been assigned.

_etag string
ETag value
_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.
access_control_configuration object[]
The list of organizational unit IDs along with role assigned to the user.
organizational_unit_ids string[]
The Clumio-assigned IDs of the organizational units assigned to the user. Use the GET /organizational-units endpoint to fetch valid values.
role_id uuid4
The Clumio-assigned ID of the role assigned to the user. Use the GET /roles endpoint to fetch valid values.
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.

{
  "_embedded": {
    "read-role": [
      {
        "description": "string",
        "id": "string",
        "name": "string",
        "permissions": [
          {
            "description": "string",
            "id": "string",
            "name": "string"
          }
        ],
        "user_count": 0
      }
    ]
  },
  "_etag": "string",
  "_links": {
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "delete-user": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "update-user": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "access_control_configuration": [
    {
      "organizational_unit_ids": [
        "string"
      ],
      "role_id": "string"
    }
  ],
  "email": "string",
  "full_name": "string",
  "id": "string",
  "inviter": "string",
  "is_confirmed": true,
  "is_enabled": true,
  "last_activity_timestamp": "string",
  "organizational_unit_count": 0
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

Create a user​

Create a user