Create Service Account | Operations for Applications REST API

Create Service Account

Creates a service account

Request

URI

POST

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

COPY

Request Body

ServiceAccountWrite of type(s) application/json

Optional

{
    "identifier": "string",
    "active": false,
    "description": "string",
    "tokens": [
        "string"
    ],
    "userGroups": [
        "string"
    ],
    "groups": [
        "string"
    ],
    "roles": [
        "string"
    ]
}

string

identifier

Required

The unique identifier for a service account.

boolean

active

Optional

The current state of the service account.

string

description

Optional

The description of the service account to be created.

array of string

tokens

Optional

The service account's API tokens.

array of string

userGroups

Optional

The list of user group ids, the service account will be added to.

array of string

groups

Optional

The list of permissions, the service account will be granted.

array of string

roles

Optional

The list of role ids, the service account will be added to."

Authentication

This operation uses the following authentication methods.

api_key

Responses

200

successful operation

Returns ResponseContainerServiceAccount of type(s) application/json

{
    "status": {
        "result": "string",
        "message": "string",
        "code": 0
    },
    "response": {
        "unitedRoles": [
            "string"
        ],
        "unitedPermissions": [
            "string"
        ],
        "tokens": [
            {
                "tokenID": "string",
                "tokenName": "string",
                "account": "string",
                "accountType": "string",
                "lastUsed": 0,
                "dateGenerated": 0
            }
        ],
        "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"
            }
        ],
        "active": false,
        "description": "string",
        "identifier": "string",
        "groups": [
            "string"
        ],
        "lastUsed": 0
    }
}

ResponseStatus

status

Required

status

ServiceAccount

response

Optional

response

On This Page

Description

Request

Request Body