Create Role

Version 4.0.25.2 (latest)

Create a role with the specified information.

Request

POST /roles

Datatype

Description

Request

HTTP Request

body

HTTP Body

Expand HTTP Body definition...

body

Role

Role

Expand Role definition...

can

object

Operations the current user is able to perform on this object

id

string

Unique Id

name

string

Name of Role

permission_set

PermissionSet

(Read only) Permission set

permission_set_id

string

(Write-Only) Id of permission set

model_set

ModelSet

(Read only) Model set

model_set_id

string

(Write-Only) Id of model set

url

string

Link to get this item

users_url

string

Link to get list of users with this role

Response

200: Role400: Bad Request404: Not Found405: Resource Can't Be Modified409: Resource Already Exists422: Validation Error429: Too Many Requests

Datatype

Description

(object)

Role

can

object

Operations the current user is able to perform on this object

id

string

Unique Id

name

string

Name of Role

permission_set

PermissionSet

(Read only) Permission set

Expand PermissionSet definition...

can

object

Operations the current user is able to perform on this object

all_access

boolean

built_in

boolean

id

string

Unique Id

name

string

Name of PermissionSet

permissions

string[]

url

string

Link to get this item

permission_set_id

string

(Write-Only) Id of permission set

model_set

ModelSet

(Read only) Model set

Expand ModelSet definition...

can

object

Operations the current user is able to perform on this object

all_access

boolean

built_in

boolean

id

string

Unique Id

models

string[]

name

string

Name of ModelSet

url

string

Link to get this item

model_set_id

string

(Write-Only) Id of model set

url

string

Link to get this item

users_url

string

Link to get list of users with this role

Datatype

Description

(object)

Error

message

string

Error details

documentation_url

string

Documentation link

Datatype

Description

(object)

Error

message

string

Error details

documentation_url

string

Documentation link

Datatype

Description

(object)

Error

message

string

Error details

documentation_url

string

Documentation link

Datatype

Description

(object)

Error

message

string

Error details

documentation_url

string

Documentation link

Datatype

Description

(object)

ValidationError

message

string

Error details

errors

ValidationErrorDetail[]

Expand ValidationErrorDetail definition...

field

string

Field with error

code

string

Error code

message

string

Error info message

documentation_url

string

Documentation link

documentation_url

string

Documentation link

Datatype

Description

(object)

Error

message

string

Error details

documentation_url

string

Documentation link