Create Or Update User Account

Creates or updates a user account

Request

URI

POST

https://{api_host}/api/v2/account/user

COPY

Query Parameters

boolean

sendEmail

Optional

Whether to send email notification to the user, if created. Default: false

Possible values are : true, false,

Request Body

UserToCreate of type(s) application/json

Optional

{
    "emailAddress": "string",
    "groups": [
        "string"
    ],
    "userGroups": [
        "string"
    ],
    "roles": [
        "string"
    ]
}

string

emailAddress

Required

The (unique) identifier of the user to create. Must be a valid email address

array of string

groups

Required

List of permission groups to grant to this user. 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

array of string

userGroups

Required

List of user groups to this user.

array of string

roles

Optional

The list of role ids, the user will be added to.

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