Get role

GET 
/roles/:roleKey

Get a role by its key.

Request

Path Parameters

roleKey int64required

The role key.

Responses

200

The role is successfully returned.

application/json

Schema

Schema

name string

The role name.

key string

The role key.

assignedMemberKeys string[]

The set of keys of members assigned to the role.

Example (from schema)

{
  "key": "string",
  "assignedMemberKeys": [
    "string"
  ],
  "name": "string"
}

application/vnd.camunda.api.keys.number+json

Schema

Schema

name string

The role name.

key int64

The role key.

assignedMemberKeys int64[]

The set of keys of members assigned to the role.

Example (from schema)

{
  "key": 0,
  "assignedMemberKeys": [
    0
  ],
  "name": "string"
}

application/vnd.camunda.api.keys.string+json

Schema

Schema

name string

The role name.

key string

The role key.

assignedMemberKeys string[]

The set of keys of members assigned to the role.

Example (from schema)

{
  "key": "string",
  "assignedMemberKeys": [
    "string"
  ],
  "name": "string"
}

401

The request lacks valid authentication credentials.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

403

Forbidden. The request is not allowed.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

The role with the given key was not found.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

An internal error occurred while processing the request.

application/problem+json

Schema

Schema

type uri

Default value: about:blank

A URI identifying the problem type.

title string

A summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code for this problem.

detail string

An explanation of the problem in more detail.

instance uri

A URI identifying the origin of the problem.

Example (from schema)

{
  "type": "about:blank",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...