Theme switcher

Create consumers

Create Consumers from the list provided. Response shall contain a list of success, falures and warning/error messages.

When specifying roles, only the following roles are allowed: Admin, Configurator, PowerUser, Viewerand only one role is allow in the roles array.

Consumers with role Admin or Configurator will automatically have groupid with value -1 and groupname All Users and Groups (current and future) so they can view all current and future groups.

Consumers with role PowerUser or Viewer may be given access to specific and existing groupid or groupname or to all current and future groups by providing -1 in the groupid.

Header Parameters

x-api-keystring Required

Public API Key

Body Parameters

consumersarray Required
Min items
1

Show child attributes

Response

200
Object
A list of success and/or failures of consumers identifier with warning/error messages.

Response Attributes

succededarray

Show child attributes

failedarray

Show child attributes

messagesarray

Show child attributes

400
Object
Bad Request. Failed StatusResponse with an error message indicating the reason of the failure, and success equal to false.

Response Attributes

messagesarray
Nullable:
True

Show child attributes

successboolean
401
Object
Unauthorized

Response Attributes

messagesarray
Nullable:
True

Show child attributes

successboolean
Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?