Previous topic

Contact

Next topic

UserService

User

Generic User

Schema

The User type represents an end user who has access to a hosting control panel. The user resource contains basic information about an end user, such as login and password. Each user must be assigned to an Account through the organization relation and may have services assigned through the services relation. Also a user contains contact details as inherited from the Contact type.

The User type schema: download

{
    "apsVersion": "2.0",

    "name": "User",
    "id": "http://aps-standard.org/types/core/user/1.0",
     
    "implements": [ "http://aps-standard.org/types/core/contact/1.2" ],

    "properties": {
    
       "login": {
          "type": "string",
          "required": true
       },
       
       "password": {
          "type": "string",
          "encrypted": true
       }
    },

    "relations": {
        "services": {
            "type": "http://aps-standard.org/types/core/user/service/1.0",
            "collection": true
        }
    }
}

Properties

The properties have to be filled with the following data:

Property

Description

login

Login name to access the control panel

password

Password to access the control panel

Relations

If a service (resource) is assigned to a user, the services collection must get a link with the service. The assigned resource must implement the UserService type with the user backward relation of the required type.

Examples

{
   "aps": {
   "id": "80a4b75e-58a7-40e4-a148-dff560e5fa4a",
   "type": "http://www.aps-standard.org/core/user/1.1",
   ...
   },

   "login": "jblack",
   "displayName": "James Black",
   "email": "admin@myinstallation.test",
   "memberId": 1,
   "userId": 1,
   ...
   "organization": {
      "aps": {
         "link": "strong",
         "href": "/aps/2/resources/b20a5ee6-7eb8-40e3-bd1c-d3dd18e95781",
         "id": "b20a5ee6-7eb8-40e3-bd1c-d3dd18e95781"
      }
   },
   "services": {
      "aps": {
         "link": "collection"
         "href": "/aps/2/resources/80a4b75e-58a7-40e4-a148-dff560e5fa4a/services"
      }
   }
}

More details about integrating applications with users in CCP v2:

Service User

A service user is the kind of user that is attached to some service as an end user.

{
    "apsVersion": "2.0",

    "name": "ServiceUser",
    "id": "http://aps-standard.org/types/core/service-user/1.0",
     
    "implements": [ "http://aps-standard.org/types/core/user/1.0" ]
}

Admin User

An admin user is the kind of user that has administrative access to the application services.

{
    "apsVersion": "2.0",

    "name": "AdminUser",
    "id": "http://aps-standard.org/types/core/admin-user/1.0",
     
    "implements": [ "http://aps-standard.org/types/core/user/1.0" ]
}