POST
Create a client profile (client account)
Client space User accounts only For: Administrator · Permission: profiles.create Conditions
  • name and roles are required. name is lowercased before validation, is at most 120 characters and must be unique among the profiles of the selected client account.
  • description is optional and at most 120 characters.
  • Every entry of roles must be distinct, must be a custom (not built-in) role of the selected client account, and must exist in this space; built-in roles cannot be chosen.
What else happens
  • Creates the profile with is_builtin set to false, owned by the selected client account and its organization.
  • Attaches the chosen roles to the profile.
Part of Define access profiles and roles.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, name, description, company_id, client_id, is_builtin, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: groupedRoles, groupedRoles.permissions.

Response

Resource (only with response=resource).

id

Identifier of the profile (27-character KSUID).

name

Name of the profile, stored in lowercase and unique within its owner.

description

Optional description, at most 120 characters.

company_id

Identifier of the company the record belongs to.

client_id

Identifier of the client owning the profile when it belongs to the client space; null for company and organization profiles.

is_builtin
boolean

True for profiles created by the system; they cannot be edited or deleted.

roles
array

Roles of the profile, one per role group with their permissions. Present only when the include groupedRoles is requested.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).