User ManagementΒΆ

Description

defaultDescription

DEFAULT

DELETE ``/api/v2/users/{user-id}``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

user-id

path

Yes

string

user id of the user

Request

Headers

authorization: Generated header parameter. Example value ='Basic c3VwZXItYWRtaW46cGFzc3dvcmQ='
provider: Generated header parameter. Example value ='root'

Responses

204

GET ``/api/v2/users``

Request

Headers

authorization: Generated header parameter. Example value ='Basic c3VwZXItYWRtaW46cGFzc3dvcmQ='
provider: Generated header parameter. Example value ='root'

Responses

200

Type: array of User

Example:

[
    {
        "activation-token": "somestring",
        "created-at": "somestring",
        "device-privilege-list": [
            {
                "d": "somestring",
                "p": [
                    "somestring",
                    "somestring"
                ],
                "v": "somestring"
            },
            {
                "d": "somestring",
                "p": [
                    "somestring",
                    "somestring"
                ],
                "v": "somestring"
            }
        ],
        "first-name": "somestring",
        "last-modified-at": "somestring",
        "last-name": "somestring",
        "local-user": true,
        "provider-id": "somestring",
        "roles": [
            {
                "superadmin": {}
            },
            {
                "superadmin": {}
            }
        ],
        "roles-list": [
            {},
            {}
        ],
        "state": "somestring",
        "use-device-hash": true,
        "user-id": "somestring"
    },
    {
        "activation-token": "somestring",
        "created-at": "somestring",
        "device-privilege-list": [
            {
                "d": "somestring",
                "p": [
                    "somestring",
                    "somestring"
                ],
                "v": "somestring"
            },
            {
                "d": "somestring",
                "p": [
                    "somestring",
                    "somestring"
                ],
                "v": "somestring"
            }
        ],
        "first-name": "somestring",
        "last-modified-at": "somestring",
        "last-name": "somestring",
        "local-user": true,
        "provider-id": "somestring",
        "roles": [
            {
                "superadmin": {}
            },
            {
                "superadmin": {}
            }
        ],
        "roles-list": [
            {},
            {}
        ],
        "state": "somestring",
        "use-device-hash": true,
        "user-id": "somestring"
    }
]

GET ``/api/v2/users/{user-id}``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

user-id

path

Yes

string

user id of the user

Request

Headers

authorization: Generated header parameter. Example value ='Basic c3VwZXItYWRtaW46cGFzc3dvcmQ='
provider: Generated header parameter. Example value ='root'

Responses

200

Type: User

Example:

{
    "activation-token": "somestring",
    "created-at": "somestring",
    "device-privilege-list": [
        {
            "d": "somestring",
            "p": [
                "somestring",
                "somestring"
            ],
            "v": "somestring"
        },
        {
            "d": "somestring",
            "p": [
                "somestring",
                "somestring"
            ],
            "v": "somestring"
        }
    ],
    "first-name": "somestring",
    "last-modified-at": "somestring",
    "last-name": "somestring",
    "local-user": true,
    "provider-id": "somestring",
    "roles": [
        {
            "superadmin": {}
        },
        {
            "superadmin": {}
        }
    ],
    "roles-list": [
        {},
        {}
    ],
    "state": "somestring",
    "use-device-hash": true,
    "user-id": "somestring"
}

GET ``/api/v2/users/{user-id}/_getactivationmail``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

user-id

path

Yes

string

user id of the user

Request

Headers

authorization: Generated header parameter. Example value ='Basic c3VwZXItYWRtaW46cGFzc3dvcmQ='
provider: Generated header parameter. Example value ='root'

Responses

200

Type: ActivationLink

Example:

{
    "link": "somestring"
}

POST ``/api/v2/sessions``

Request

Headers

authorization: Generated header parameter. Example value ='Basic c3VwZXItYWRtaW46cGFzc3dvcmQ='
provider: Generated header parameter. Example value ='root'

Body

Name

Required

Type

Format

Properties

Description

userId

No

string

{
    "userId": "somestring"
}

Responses

201

Type: SessionResponse

Example:

{
    "authenticationProvider": {
        "inheritable": "somestring",
        "type": "somestring"
    },
    "createdAt": "somestring",
    "id": "somestring",
    "lastAccessedAt": "somestring",
    "provider": {
        "authenticationProvider": {
            "inheritable": "somestring",
            "type": "somestring"
        },
        "created-at": "somestring",
        "last-modified-at": "somestring",
        "name": "somestring",
        "services": [
            "somestring",
            "somestring"
        ],
        "terms-accepted": true,
        "uuid": "somestring"
    },
    "providerId": "somestring",
    "userId": "somestring"
}

POST ``/api/v2/users``

Request

Headers

authorization: Generated header parameter. Example value ='Basic c3VwZXItYWRtaW46cGFzc3dvcmQ='
provider: Generated header parameter. Example value ='root'

Body

Name

Required

Type

Format

Properties

Description

email-id

No

string

first-name

No

string

last-name

No

string

user-id

No

string

{
    "email-id": "somestring",
    "first-name": "somestring",
    "last-name": "somestring",
    "user-id": "somestring"
}

Responses

201

Type: CreateUserResponse

Example:

{
    "activation-token": "somestring",
    "created-at": "somestring",
    "device-privilege-list": [
        {},
        {}
    ],
    "email-id": "somestring",
    "first-name": "somestring",
    "last-modified-at": "somestring",
    "last-name": "somestring",
    "local-user": true,
    "provider-id": "somestring",
    "roles": [
        {
            "superadmin": {}
        },
        {
            "superadmin": {}
        }
    ],
    "roles-list": [
        {},
        {}
    ],
    "state": "somestring",
    "use-device-hash": true,
    "user-id": "somestring"
}

POST ``/api/v2/users/{user-id}/activate``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

user-id

path

Yes

string

user id of the user

Request

Headers

authorization: Generated header parameter. Example value ='Basic c3VwZXItYWRtaW46cGFzc3dvcmQ='
provider: Generated header parameter. Example value ='root'

Body

Name

Required

Type

Format

Properties

Description

body

No

string

"somestring"

Responses

204

PUT ``/api/v2/providers/{provider-name}/rbac/user/{user-id}``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

provider name

user-id

path

Yes

string

user id of the user

Request

Headers

authorization: Generated header parameter. Example value ='Basic c3VwZXItYWRtaW46cGFzc3dvcmQ='
provider: Generated header parameter. Example value ='root'

Body

Name

Required

Type

Format

Properties

Description

providerId

No

string

roles

No

array of string

userId

No

string

{
    "providerId": "somestring",
    "roles": [
        "somestring",
        "somestring"
    ],
    "userId": "somestring"
}

Responses

200

Type: UpdateUserRoleResponse

Example:

{
    "createdAt": "somestring",
    "lastModifiedAt": "somestring",
    "lastModifiedBy": "somestring",
    "providerId": "somestring",
    "roles": [
        {
            "hc_provider_admin-root": "somestring"
        },
        {
            "hc_provider_admin-root": "somestring"
        }
    ],
    "userId": "somestring"
}

Data Structures

Activation Link Model Structure

Name

Required

Type

Format

Properties

Description

link

No

string

Authentication Provider Model Structure

Name

Required

Type

Format

Properties

Description

inheritable

No

string

type

No

string

Create User Request Model Structure

Name

Required

Type

Format

Properties

Description

email-id

No

string

first-name

No

string

last-name

No

string

user-id

No

string

Create User Response Model Structure

Name

Required

Type

Format

Properties

Description

activation-token

No

string

created-at

No

string

device-privilege-list

No

array of superadmin

email-id

No

string

first-name

No

string

last-modified-at

No

string

last-name

No

string

local-user

No

boolean

provider-id

No

string

roles

No

array of Roles

roles-list

No

array of superadmin

state

No

string

use-device-hash

No

boolean

user-id

No

string

Superadmin schema:

Device Privilege List Model Structure

Name

Required

Type

Format

Properties

Description

d

No

string

p

No

array of string

v

No

string

Provider Model Structure

Name

Required

Type

Format

Properties

Description

authenticationProvider

No

AuthenticationProvider

created-at

No

string

last-modified-at

No

string

name

No

string

services

No

array of string

terms-accepted

No

boolean

uuid

No

string

Roles Model Structure

Name

Required

Type

Format

Properties

Description

superadmin

No

superadmin

Superadmin schema:

Session Request Model Structure

Name

Required

Type

Format

Properties

Description

userId

No

string

Session Response Model Structure

Name

Required

Type

Format

Properties

Description

authenticationProvider

No

SessionResponse_AuthenticationProvider

createdAt

No

string

id

No

string

lastAccessedAt

No

string

provider

No

Provider

providerId

No

string

userId

No

string

Session Response Authentication Provider Model Structure

Name

Required

Type

Format

Properties

Description

inheritable

No

string

type

No

string

Update User Role Request Model Structure

Name

Required

Type

Format

Properties

Description

providerId

No

string

roles

No

array of string

userId

No

string

Update User Role Response Model Structure

Name

Required

Type

Format

Properties

Description

createdAt

No

string

lastModifiedAt

No

string

lastModifiedBy

No

string

providerId

No

string

roles

No

array of UpdateUserRoleResponse_Roles

userId

No

string

Update User Role Response Roles Model Structure

Name

Required

Type

Format

Properties

Description

hc_provider_admin-root

No

string

User Model Structure

Name

Required

Type

Format

Properties

Description

activation-token

No

string

created-at

No

string

device-privilege-list

No

array of Device-privilege-list

first-name

No

string

last-modified-at

No

string

last-name

No

string

local-user

No

boolean

provider-id

No

string

roles

No

array of Roles

roles-list

No

array of superadmin

state

No

string

use-device-hash

No

boolean

user-id

No

string

Superadmin schema: