UserManagement

This APS type defines the platform built-in User Management Service that exposes some operations to manage service users.

Schema

The considered APS type (download) extends the Resource APS type(s) and looks as follows:

{
  "name": "UserManagement",
  "id": "http://www.parallels.com/pa/pa-core-services/user-management/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "access": {
    "global": true
  },
  "operations": {
    "createServiceUsers": {
      "path": "users",
      "verb": "POST",
      "response": {
        "type": "array",
        "items": {
          "type": "object"
        }
      },
      "errorResponse": {
        "type": "object"
      }
    },
    "deleteServiceUsers": {
      "path": "users",
      "verb": "DELETE",
      "errorResponse": {
        "type": "object"
      }
    },
    "updateServiceUsers": {
      "path": "users",
      "verb": "PUT",
      "response": {
        "type": "array",
        "items": {
          "type": "object"
        }
      },
      "errorResponse": {
        "type": "object"
      }
    },
    "checkUserData": {
      "path": "users/checkData",
      "verb": "POST",
      "errorResponse": {
        "type": "object"
      }
    }
  }
}

Custom Operations

OPERATION	VERB	PATH	RETURNS	Description
checkUserData	POST	users/checkData	If successful, this method returns the 200 OK standard status code.	Check if the specified input user representation corresponds to the user object stored in the database.
createServiceUsers	POST	users	If successful, this method returns a list of created users in the response body.	Create several service users from the input list.
deleteServiceUsers	DELETE	users	If successful, this method returns the 200 OK standard status code.	Delete service users specified in the input list of user IDs.
updateServiceUsers	PUT	users	If successful, this method returns a list of updated users in the response body.	Update the properties of the service users specified in the input list of user objects.

checkUserData

HTTP Request

POST /aps/2/resources/{aps-id}/users/checkData

Description

Check if the specified input user representation corresponds to the user object stored in the database.

Parameters

PARAMETER	TYPE	DESCRIPTION
user	PAUser	A user representation PAUser to check.

Returns

If successful, this method returns the 200 OK standard status code.

createServiceUsers

HTTP Request

POST /aps/2/resources/{aps-id}/users

Description

Create several service users from the input list.

Parameters

PARAMETER	TYPE	DESCRIPTION
serviceUsers	PAUser	List of users PAUser to create.

Returns

If successful, this method returns a list of created users in the response body.

deleteServiceUsers

HTTP Request

DELETE /aps/2/resources/{aps-id}/users

Description

Delete service users specified in the input list of user IDs.

Parameters

PARAMETER	TYPE	DESCRIPTION
userIdArray	String	An array of user identifiers.

Returns

If successful, this method returns the 200 OK standard status code.

updateServiceUsers

HTTP Request

PUT /aps/2/resources/{aps-id}/users

Description

Update the properties of the service users specified in the input list of user objects.

Parameters

PARAMETER	TYPE	DESCRIPTION
serviceUsers	PAUser	List of users PAUser to update.

Returns

If successful, this method returns a list of updated users in the response body.

Examples

Since the considered APS type contains custom operations, refer to Custom Operations for the general explanation of their structure and examples of operation calls.

← PrivilegeManagement

Domain Management →