Get
/sys/v1/roles/{custom_role_id}
Lookup a role.
Security
HTTP
Type bearer
API Key: apiKeyAuth
Header parameter nameAuthorization
Path parameters
custom_role_id
string (uuid) Required
Responses
2XX
Success result
object
created_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
creator
OneOf
PrincipalVariantApp
object (PrincipalVariantApp)
app
string (uuid)
PrincipalVariantUser
object (PrincipalVariantUser)
user
string (uuid)
PrincipalVariantPlugin
object (PrincipalVariantPlugin)
plugin
string (uuid)
PrincipalVariantUserViaApp
object (PrincipalVariantUserViaApp)
userviaapp
object
user_id
string (uuid)
scopes
Array of string (OauthScope)
string
Valid values[
"app",
"openid",
"email",
"profile"
]
string
string
Valid values[
"system"
]
string
string
Valid values[
"unregistereduser"
]
description
string
details
OneOf
object
object
kind
string
Valid values[
"account"
]
permissions
Array of string (AccountPermissions)
string
Valid values[
"MANAGE_LOGGING",
"MANAGE_AUTH",
"MANAGE_WORKSPACE_CSE",
"UNWRAP_WORKSPACE_CSE_PRIVILEGED",
"MANAGE_ACCOUNT_CLIENT_CONFIGS",
"MANAGE_PLUGIN_CODE_SIGNING_POLICY",
"CREATE_ACCOUNT_APPROVAL_POLICY",
"SET_APPROVAL_REQUEST_EXPIRY",
"MANAGE_APPROVAL_REQUEST_SETTINGS",
"UPDATE_ACCOUNT_CUSTOM_METADATA_ATTRIBUTES",
"MANAGE_ACCOUNT_SUBSCRIPTION",
"MANAGE_ACCOUNT_PROFILE",
"DELETE_ACCOUNT",
"CREATE_ADMIN_APPS",
"UPDATE_ADMIN_APPS",
"DELETE_ADMIN_APPS",
"RETRIEVE_ADMIN_APP_SECRETS",
"MANAGE_ADMIN_APPS",
"CREATE_CUSTOM_ROLES",
"UPDATE_CUSTOM_ROLES",
"DELETE_CUSTOM_ROLES",
"MANAGE_CUSTOM_ROLES",
"INVITE_USERS_TO_ACCOUNT",
"DELETE_USERS_FROM_ACCOUNT",
"UPDATE_USERS_ACCOUNT_ROLE",
"UPDATE_USERS_ACCOUNT_ENABLED_STATE",
"MANAGE_ACCOUNT_USERS",
"CREATE_EXTERNAL_ROLES",
"SYNC_EXTERNAL_ROLES",
"DELETE_EXTERNAL_ROLES",
"MANAGE_EXTERNAL_ROLES",
"CREATE_ACCOUNT_SOBJECT_POLICIES",
"UPDATE_ACCOUNT_SOBJECT_POLICIES",
"DELETE_ACCOUNT_SOBJECT_POLICIES",
"MANAGE_ACCOUNT_SOBJECT_POLICIES",
"CREATE_CHILD_ACCOUNTS",
"UPDATE_CHILD_ACCOUNTS",
"DELETE_CHILD_ACCOUNTS",
"CREATE_CHILD_ACCOUNT_USERS",
"GET_CHILD_ACCOUNTS",
"GET_CHILD_ACCOUNT_USERS",
"MANAGE_CHILD_ACCOUNTS",
"CREATE_LOCAL_GROUPS",
"CREATE_EXTERNAL_GROUPS",
"ALLOW_QUORUM_REVIEWER",
"ALLOW_KEY_CUSTODIAN",
"GET_ALL_APPROVAL_REQUESTS",
"GET_ADMIN_APPS",
"GET_CUSTOM_ROLES",
"GET_EXTERNAL_ROLES",
"GET_ALL_USERS",
"GET_ACCOUNT_USAGE",
"MANAGE_KEY_EXPIRY_ALERTS",
"MANAGE_REPLICATION"
]
exclusive
boolean | null
all_groups_role
string (uuid) | null
object
object
kind
string
Valid values[
"group"
]
permissions
Array of string (GroupPermissions)
string
Valid values[
"CREATE_GROUP_APPROVAL_POLICY",
"UPDATE_GROUP_EXTERNAL_LINKS",
"MANAGE_GROUP_CLIENT_CONFIGS",
"UPDATE_GROUP_PROFILE",
"DELETE_GROUP",
"MAP_EXTERNAL_ROLES_FOR_APPS",
"MAP_EXTERNAL_ROLES_FOR_USERS",
"MAP_EXTERNAL_ROLES",
"ADD_USERS_TO_GROUP",
"DELETE_USERS_FROM_GROUP",
"UPDATE_USERS_GROUP_ROLE",
"MANAGE_GROUP_USERS",
"CREATE_GROUP_SOBJECT_POLICIES",
"UPDATE_GROUP_SOBJECT_POLICIES",
"DELETE_GROUP_SOBJECT_POLICIES",
"MANAGE_GROUP_SOBJECT_POLICIES",
"CREATE_GROUP_CUSTODIAN_POLICY",
"UPDATE_GROUP_CUSTODIAN_POLICY",
"DELETE_GROUP_CUSTODIAN_POLICY",
"MANAGE_GROUP_CUSTODIAN_POLICY",
"CREATE_APPS",
"UPDATE_APPS",
"RETRIEVE_APP_SECRETS",
"DELETE_APPS",
"MANAGE_APPS",
"CREATE_PLUGINS",
"UPDATE_PLUGINS",
"INVOKE_PLUGINS",
"DELETE_PLUGINS",
"MANAGE_PLUGINS",
"CREATE_SOBJECTS",
"EXPORT_SOBJECTS",
"COPY_SOBJECTS",
"WRAP_SOBJECTS",
"UNWRAP_SOBJECTS",
"DERIVE_SOBJECTS",
"TRANSFORM_SOBJECTS",
"UPDATE_SOBJECTS_ENABLED_STATE",
"ROTATE_SOBJECTS",
"DELETE_SOBJECTS",
"DESTROY_SOBJECTS",
"REVOKE_SOBJECTS",
"ACTIVATE_SOBJECTS",
"REVERT_SOBJECTS",
"DELETE_KEY_MATERIAL",
"MOVE_SOBJECTS",
"UPDATE_KEY_OPS",
"UPDATE_SOBJECT_POLICIES",
"UPDATE_SOBJECTS_PROFILE",
"SCAN_EXTERNAL_SOBJECTS",
"RESTORE_EXTERNAL_SOBJECTS",
"WRAP_WORKSPACE_CSE",
"UNWRAP_WORKSPACE_CSE",
"WORKSPACE_CSE",
"GET_GROUP",
"GET_SOBJECTS",
"GET_APPS",
"GET_PLUGINS",
"GET_GROUP_APPROVAL_REQUESTS",
"GET_AUDIT_LOGS",
"MANAGE_GROUP_WRAPPING_KEY",
"ENCAPSULATE_SOBJECTS",
"DECAPSULATE_SOBJECTS"
]
exclusive
boolean | null
kind
string
Valid values[
"account",
"group"
]
last_updated_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
name
string
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
role_id
string (uuid)
acct_id
string (uuid)