Backend API's

User List

GET /api/id-management/users/

This endpoint allows you to get a list of Users

Query Parameters

Name	Type	Description
workspaces	array
name_email	string
roles	array
partners	array
clusters	array

200 Cake successfully retrieved.

{
    "name": "Cake's name",
    "recipe": "Cake's recipe name",
    "cake": "Binary cake"
}

404 Could not find a cake matching this query.

{
    "message": "Ain't no cake like that."
}

Create a new User

POST /api/id-management/users/

Request Body

Name	Type	Description
last_name	string
position	string
email	string	Valid email address format
first_name	string

200

Delete a PRPRole instance

DELETE /api/id-management/role-group/:id

Allows a valid user to delete one instance of a role group

200

Patch an existing PRPRole instance

PATCH /api/id-management/role-group/:id

Used when a role is changed in an existing PRPRole instance by a valid user. Validation on the role should be done. Eg. an IMO cannot assign a super user role or a IP authorized officer cannot assign an IMO role etc. Additionally the user to which this PRPRole is assigned to, should be one that the requesting user is allowed to modify.

Path Parameters

Name	Type	Description
role	string	Valid role string

200

Create PRPRoles

POST /api/id-management/role-group/

This endpoint allows a valid user to create multiple roles for a single user.

Request Body

Name	Type	Description
prp_roles	array	an array of {"role": "ROLE_TYPE", "cluster": cluster_id, "workspace": workspace_id}
user_id	integer

200

Assignable Cluster List

GET /api/id-management/assignable-clusters/

This endpoint allows a valid user to list all user's clusters that can be assigned to other users

200

Partner List

GET /api/id-management/partners/

This endpoint allows you to get a list of partners.

Query Parameters

Name	Type	Description
partner_type	string
clusters	array
title	string

200

Create a partner

POST /api/id-management/partners/

This endpoint allows a valid user to create a partner.

Request Body

Name	Type	Description
ocha_id	string
external_id	string
external_source	string
title	string	Full Name
short_title	string
shared_partner	string
alternate_title	string
cso_type	string
partner_type	string
phone_number	string
email	string
city	string
street_address	string
country_code	string
postal_code	string
total_ct_cy	number	Total Cash Transferred per Current Year
total_ct_cp	number	Total Cash Transferred for Country Programme
alternate_id	integer
vendor_number	string
type_of_assessment	string
raiting	string	Risk Rating
basis_for_risk_raiting	string
clusters	array

200