10 User Management

10.1 Add-anynodeUser

Adds a new user.

Required Permissions

  • API

  • 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 displayed name of the new user.

    Type: String

  • EmailAddress

    The email address of the new user.

    Type: String

  • Enabled

    Determines if the new user should be enabled. Disabled user cannot login.

    Type: Boolean

  • LdapAuthentications

    Add LDAP users here to link this user to LDAP users.

    Type: Array of LdapUserJson

  • LdapLogin

    Defines if the user should be able to login with LDAP credentials.

    Type: Boolean

  • LocalPassword

    The password for local authentication.

    Type: String

  • LocalUsername

    The username for local authentication.

    Type: String

  • LoginLocally

    Defines if the user should be able to login with a local username and password.

    Type: Boolean

  • PasswordChange

    Define whether and, if so, when the password has to be changed.

    Type: PasswordChange

    Possible values:

    • NOT_NECESSARY

    • REQUIERED

    • RECOMMENDED

  • RoleIds

    Add roles for this user to determine the permissions.

    Type: Array of String

Return Value Structure

The response body is structured as CustomUserOptions JSON object. A description for its fields is at section 29.15.1. For the JSON schema refer to section 29.15.2.

10.2 Remove-anynodeUser

Removes an exiting user

Required Permissions

  • API

  • 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: User

    The name or id of the user that should be removed.

Return Value Structure

The response body is structured as CustomUserOptions JSON object. A description for its fields is at section 29.15.1. For the JSON schema refer to section 29.15.2.

10.3 Submit-anynodePasswordChange

Sets a new password for a user.

Required Permissions

  • API

  • 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: PasswordChange

    Define whether and, if so, when the password has to be changed.

    Possible values:

    • NOT_NECESSARY

    • REQUIERED

    • RECOMMENDED

  • string: OldPassword

    The old password of the selected user.

  • string: NewPassword

    The new password of the selected user.

  • string: User

    The name of the user which password will be changed.

10.4 Get-anynodeLdapAuthorities

Returns the configured LDAP Authorities

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 strutured as an array. The array consists of LdapAuthority JSON objects. A description for its fields is at section 29.71.1. For the JSON schema refer to section 29.71.2.