Create Role
Creates a role with a specific unique name. Optionally, you can grant permissions to the role, assign the role to accounts and groups, specify a description, and configure the management properties of the role.
Request
URI
POST
https://{api_host}/api/v2/role
COPY
Request Body
An example body for a role with all permissions:
{
"name": "Role_name",
"permissions": [
"agent_management", "alerts_management",
"application_management", "batch_query_priority",
"dashboard_management", "derived_metrics_management",
"embedded_charts", "events_management",
"external_links_management", "host_tag_management",
"ingestion", "metrics_management",
"monitored_application_service_management", "saml_sso_management",
"token_management", "user_management"
],
"description": "Role_description"
}
RoleCreateDTO of type(s) application/json
Required
{
"permissions": [
"string"
],
"name": "string",
"description": "string"
}array of string
permissions
Optional
List of permissions the role has been granted access to
string
name
Optional
The name of the role
string
description
Optional
The description of the role
Responses
200
successful operation
Returns ResponseContainerRoleDTO of type(s) application/json
{
"status": {
"result": "string",
"message": "string",
"code": 0
},
"response": {
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": 0,
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": 0,
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": false,
"usersRemovable": false,
"usersAddable": false,
"permsEditable": false,
"deletable": false
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": 0,
"lastUpdatedMs": 0,
"lastUpdatedAccountId": "string",
"customer": "string"
}
}