Grant Permission To Users | Operations for Applications REST API

Grant Permission To Users

Grants a specific permission to multiple users or service accounts

Request

URI

POST

https://{api_host}/api/v2/user/grant/{permission}

COPY

Path Parameters

string

permission

Required

Permission to grant to the users. Please note that 'host_tag_management' is the equivalent of the 'Source Tag Management' permission

Possible values are : log_management, dashboard_management, events_management, alerts_management, derived_metrics_management, host_tag_management, agent_management, token_management, ingestion, user_management, embedded_charts, metrics_management, external_links_management, application_management, batch_query_priority, saml_sso_management, monitored_application_service_management,

Request Body

List of users which should be granted by specified permission

Array of string of type(s) application/json

Optional

[
    {}
]

Authentication

This operation uses the following authentication methods.

api_key

Responses

200

successful operation

Returns UserModel of type(s) application/json

{
    "identifier": "string",
    "customer": "string",
    "ssoId": "string",
    "lastSuccessfulLogin": 0,
    "groups": [
        "string"
    ],
    "userGroups": [
        {
            "id": "04e5fd3a-c916-45aa-923c-2fa02e9eddac",
            "name": "string",
            "customer": "string",
            "users": [
                "string"
            ],
            "userCount": 0,
            "properties": {
                "nameEditable": false,
                "usersEditable": false,
                "rolesEditable": false
            },
            "description": "string",
            "roles": [
                "RoleDTO Object"
            ]
        }
    ],
    "roles": [
        {
            "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"
        }
    ]
}

string

identifier

Required

The unique identifier of this user, which must be their valid email address

string

customer

Required

The id of the customer to which this user belongs

string

ssoId

Optional

ssoId