getRole
get
/ccadmin/v1/roles/{id}
Get Role. Returns a role by ID.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The role ID.
Query Parameters
-
preview(optional): boolean
If set to true, gets a role for preview users. Defaults to false.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getRole_response
Type:
Show Source
object
-
accessRights(optional):
array accessRights
Access rights assigned to role
-
description(optional):
string
Description of role
-
function(optional):
string
Function name for organizationRole
-
id(optional):
string
ID of role
-
name(optional):
string
Name of role
-
relativeTo(optional):
object relativeTo
Related organization for organizationRole
-
repositoryId(optional):
string
Repository ID of role
-
type(optional):
string
Type of role (role or organizationalRole)
Nested Schema : relativeTo
Type:
object
Related organization for organizationRole
Show Source
-
externalOrganizationId(optional):
string
External organization id
-
id(optional):
string
Repository ID of related organization
Nested Schema : items
Type:
Show Source
object
-
description(optional):
string
Description of access right
-
displayName(optional):
string
Display name of access right
-
id(optional):
string
ID of access right
-
name(optional):
string
Name of access right
-
repositoryId(optional):
string
Repository ID of access right
-
type(optional):
string
Type of access right
Example Response (application/json)
{
"function":"accountAddressManager",
"relativeTo":{
"id":"or-100000",
"externalOrganizationId":null
},
"name":"Account Address Manager",
"repositoryId":"100001",
"description":null,
"id":"100001",
"accessRights":[
{
"displayName":null,
"name":"Create Account Address",
"repositoryId":"createAccountAddress",
"description":null,
"id":"createAccountAddress",
"type":"generic"
},
{
"displayName":null,
"name":"Update Account Address",
"repositoryId":"updateAccountAddress",
"description":null,
"id":"updateAccountAddress",
"type":"generic"
}
],
"type":"organizationalRole"
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code