11 Roles

11.1 Get-anynodeRoles

Returns all congigured roles.

Required Permissions

  • API

  • User Management Read Access

Request parameters

  • Address

    mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.

    Type: String

  • Port

    mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.

    Type: Integer

  • APIVersion = 0

    This parameter states which version of the request should be used.

    Type: Integer

Return Value Structure

The response body is structured as Role JSON object. A description for its fields is at section 25.16.1. For the JSON schema refer to section 25.16.2.

11.2 Add-anynodeRole

Adds a new role

Required Permissions

  • User Management Read/Write Access

Request parameters

  • Address

    mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.

    Type: String

  • Port

    mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.

    Type: Integer

  • APIVersion = 0

    This parameter states which version of the request should be used.

    Type: Integer

  • DisplayName

    The displayname of the role..

    Type: String

  • Id

    A unique identifier for the role.

    Type: String

  • Permissions

    The permission that users with this role have.

    Type: Permissions

Return Value Structure

The response body is structured as Role JSON object. A description for its fields is at section 25.16.1. For the JSON schema refer to section 25.16.2.

11.3 Remove-anynodeRole

Remove an existing role.

Required Permissions

  • User Management Read/Write Access

Request parameters

  • Address

    mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.

    Type: String

  • Port

    mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.

    Type: Integer

  • APIVersion = 0

    This parameter states which version of the request should be used.

    Type: Integer

  • string: Role

    The id or displayname of the role to be removed.