User Profiles Types¶

When creating an APIO Reseller Admin or an APIO Local User one of the main parameters is the User Profile Type. It groups a set of properties (user levle, login mode, …) that will be used to create the user in APIO DB. It allows the operator to pre-define the different types of users that can be created.

GET /api/v1/config/userprofiletypes/¶

Gets the list of the configured User Profile Types for this instance

Example request:

GET /api/v1/config/userprofiletypes/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "userLevel": 8,
}

Request JSON Object:

userLevel (integer) – (Optional) filter the list of User Profile Types to return only the ones with that value for the userLevel property.
accessType (integer) – (Optional) filter the list of User Profile Types to return only the ones with that value for the accessType property.
readOnly (boolean) – (Optional) filter the list of User Profile Types to return only the ones with that value for the readOnlyproperty.

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   'userProfileTypes': [
     {
        'userType': 'End_User',
        'description': '',
        'accessType': 0,
        'readOnly': False,
        'userLevel': 0,
        'loginMode': 0,
        'backendType': 2,
        'backendName': 'AS_XSP_32_138'
     },
     {
        'userType': 'Group_Admin',
        'description': '',
        'accessType': 0,
        'readOnly': False,
        'userLevel': 8,
        'loginMode': 0,
        'backendType': 2,
        'backendName': 'AS_XSP_32_138'
     }
   ]
}

Response JSON Object:

userProfileTypes (array) – a list of objects as defined as User Profile Type Object

Status Codes:

200 OK – no error
404 Not Found – no backend could be found.

User Profile Type Object¶

Login profile attributes¶

Name	Present	Type	Description
userType	always	String	The name of this User Profile Type
description	always	String	The description of this User Profile Type
userLevel	always	Int	The access rights level. See User Levels.
accessType	always	Int	The access level. See User Access Types.
loginMode	always	Int	The login mode : 0: Server Login, 1: Local Login Shared, 2: Local Login Dedicated 3: SSO Login, 4: APIO Admin Login
readOnly	always	Boolean	Readonly access
backendType	always	String	The type of the backend hosting the users (the list can be adapetd for each project: 1: APIO Admin, 2: Broadsoft AS, 3: Broadsoft NS
backendName	optional	String	The name of the NE Backend hosting the users. Present only if it is needed to have different properties depending on the backend.