UserActivateResponse

The response to a user Activate / Deactivate request. Check the results object for the outcome details

response_codeinteger

HTTP status code of the response for reference purposes.

Default value: 200

Example: 200

successboolean

Indicates whether the request was successful (normally true if it's not an error response).

Default value: true

uristring

URL of the current request / resource, for reference purposes.

Example: https://example.apps.journyx.com/api/v1/users

statusstring[]

An array of status (confirmation) messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a green icon.

errorsstring[]

An array of error messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a red error icon.

warningsstring[]

An array of warning messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a yellow warning icon.

infostring[]

An array of informational messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a blue info icon.

results object

The details about a request to activate or deactivate a set of users.

changed_usersstring[]

A list of the User IDs that were activated or deactivated.

unchanged_usersstring[]

A list of the User IDs that were not activated or deactivated, typically because they were already in the desired state.

activatedboolean

Indicates whether the users were activated. (Based on the `activate parameter in the request.)

Example: true

deactivatedboolean

Indicates whether the users were deactivated. (Based on the activate parameter in the request.)

Example: false

UserActivateResponse

{
  "response_code": 200,
  "success": true,
  "uri": "https://example.apps.journyx.com/api/v1/users",
  "status": [
    "string"
  ],
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "info": [
    "string"
  ],
  "results": {
    "changed_users": [
      "5CD906A3941C463B9CC98F49DBCC25AA"
    ],
    "unchanged_users": [
      "5CD906A3941C463B9CC98F49DBCC25AA"
    ],
    "activated": true,
    "deactivated": false
  }
}