These APIs are not supported with the Britive Profiles enhanced feature.
You can use Britive API methods for managing profile identities (also known as users) such as adding or deleting profile identities in the system.
1. Add Identity to a Profile
The POST method allows you to add an identity to a profile in the system.
| POST | {{url}}/api/paps/{{papID}}/users/{{userID}} |
Request Example
An example request is shown here.
curl --location --request POST '{{url}}/api/paps/{{papID}}/users/{{userID}}' \
--header 'Authorization: TOKEN {{token}}'Response Example
An example response is shown here:
| Status: 200 OK |
{
"accessPeriod": null,
"mappedAccounts": [],
"name": "Steve Aragon",
"userType": "User",
"status": "active",
"checkStatus": "Success",
"message": null,
"userId": "7tBKs8yPzuTdLwdiSkED",
"username": "steve"
}2. Retrieve Assigned Profile Identities
The GET method allows you to retrieve the available identities (users) that are assigned to a profile for the given profile ID. The API returns data in pages. Multiple API calls return the complete list of identities for the profile.
| GET | {{url}}/api/paps/{{papID}}/users?page=0&size=20&sort=username,asc&filter=email eq "test@brit.com" |
Request Parameters
The request parameters used in this method are shown in the following table:
| Parameter | Description | Data Type | Required |
| papID | The profile ID. | string | Mandatory |
page | The page number starting from zero. | string | Mandatory |
size | The number of records that are returned. Note: The total number of records can be used to calculate the number of pages. For example, 20. | string | Mandatory |
sort | The column used for sorting the records. | string | Optional |
filter | The filter that can filter the list of identities (users) based on name, status, or integrity checks. The supported operators are 'eq' and 'co'. The format is as follows: name co "user1" | string | Optional |
Request Example
An example request is shown here:
curl --location --request GET '{{url}}/api/paps/{{papID}}/users?page=0&size=20&sort=username,asc&filter=username%20eq%20testuser' \
--header 'Authorization: TOKEN {{token}}'Response Example
An example response is shown here.
| Status: 200 OK |
{
"count": 1,
"page": 0,
"size": 20,
"sort": "username: ASC",
"filter": "username eq testuser",
"data": [
{
"accessPeriod": null,
"mappedAccounts": [
"user1@brit.com"
],
"name": "Test User",
"userType": "User",
"status": "active",
"checkStatus": "Success",
"message": null,
"userId": "947LkZn6Hu9rf02JmwLg",
"username": "testuser"
}
]
}(Deprecated) Details of Profile Identities
The GET method allows you to retrieve the available identities associated with a profile in the system.
| GET | {{url}}/api/paps/{{papID}}/users?filter=available |
Request Example
An example request is shown here:
curl --location --request GET '{{url}}/api/paps/{{papID}}/users?filter=available' \
--header 'Authorization: TOKEN {{token}}'Response Example
An example response is shown here.
| Status: 200 OK |
[
{
"adminRoles": null,
"type": "User",
"email": "joe.smith@brit.com",
"username": "joe",
"firstName": "Joe",
"lastName": "Smith",
"name": "Joe Smith",
"externalId": null,
"mobile": "9999999999",
"identityProvider": null,
"mappedAccounts": [],
"external": false,
"status": "active",
"userId": "CdtUJDFEx1B8V7TxkVBa"
},
{
"adminRoles": null,
"type": "User",
"email": "john.wilson@brit.com",
"username": "john@brit.com",
"firstName": "John",
"lastName": "Wilson",
"name": "John Wilson",
"externalId": null,
"mobile": null,
"identityProvider": null,
"mappedAccounts": [],
"external": false,
"status": "active",
"userId": "pttUAhzvgDmxmrIocOnt"
},
{
"adminRoles": null,
"type": "User",
"email": "Dave@brit.com",
"username": "Dave@brit.com",
"firstName": "Dave",
"lastName": "Flatt",
"name": "Dave Flatt ",
"externalId": null,
"mobile": null,
"identityProvider": null,
"mappedAccounts": [],
"external": false,
"status": "active",
"userId": "HcQ1EC9KnmENb7VBTZtU"
},
{
"adminRoles": null,
"type": "User",
"email": "jerry.wong@brit.com",
"username": "jerry.wong@brit.com",
"firstName": "Jerry",
"lastName": "Wong",
"name": "Jerry Wong",
"externalId": null,
"mobile": null,
"identityProvider": null,
"mappedAccounts": [],
"external": false,
"status": "active",
"userId": "SxTHu9M4qf9ITUFP0qqe"
},
{
"adminRoles": null,
"type": "User",
"email": "sam.john@brit.com",
"username": "sam.john@brit.com",
"firstName": "Sam",
"lastName": "John",
"name": "Sam John",
"externalId": null,
"mobile": null,
"identityProvider": null,
"mappedAccounts": [],
"external": false,
"status": "active",
"userId": "EI7tuN4bAgslFswpjWiY"
},
{
"adminRoles": null,
"type": "User",
"email": "rag@brit.com",
"username": "rsaval",
"firstName": "Rag",
"lastName": "Saval",
"name": "Rag Saval",
"externalId": null,
"mobile": null,
"identityProvider": null,
"mappedAccounts": [],
"external": false,
"status": "active",
"userId": "TOOwYOq8R9gP34ZJx5WO"
},
{
"adminRoles": null,
"type": "User",
"email": "noel.smith@brit.com",
"username": "noel",
"firstName": "Noel",
"lastName": "Smith",
"name": "Noel Smith",
"externalId": null,
"mobile": null,
"identityProvider": null,
"mappedAccounts": [],
"external": false,
"status": "active",
"userId": "Wt4DeoC9yEomBEmFrKWZ"
},
{
"adminRoles": null,
"type": "User",
"email": "soth.na@brit.com",
"username": "soth.na@brit.com",
"firstName": "Soth",
"lastName": "Na",
"name": "Soth Na",
"externalId": null,
"mobile": null,
"identityProvider": null,
"mappedAccounts": [],
"external": false,
"status": "active",
"userId": "JfKOMksEhj32PsXbGHQl"
},
{
"adminRoles": null,
"type": "User",
"email": "vin.shan@brit.com",
"username": "vin",
"firstName": "Vin",
"lastName": "Shan",
"name": "Vin Shan",
"externalId": null,
"mobile": null,
"identityProvider": null,
"mappedAccounts": [],
"external": false,
"status": "active",
"userId": "3S14LKpgOBvjiZo3G0mm"
},
{
"adminRoles": null,
"type": "User",
"email": "testuser1@brit.com",
"username": "testuser1",
"firstName": "Test",
"lastName": "User",
"name": "Test User",
"externalId": null,
"mobile": null,
"identityProvider": null,
"mappedAccounts": [],
"external": false,
"status": "active",
"userId": "ud0arjrn0n1slnk0ufkf"
},
{
"adminRoles": null,
"type": "ServiceIdentity",
"email": "",
"username": "serviceidentity21",
"firstName": null,
"lastName": null,
"name": "serviceidentity21",
"externalId": null,
"mobile": null,
"identityProvider": null,
"mappedAccounts": [],
"external": false,
"status": "active",
"userId": "7m6ad1uglka5y0wbax9e"
}
]3. Delete Identity from a Profile
The DELETE method allows you to delete the identity associated with a profile in the system.
| DELETE | {{url}}/api/paps/{{papID}}/users/{{userID}} |
Request Example
An example request is shown here:
curl --location --request DELETE '{{url}}/api/paps/{{papID}}/users/{{userID}}' \
--header 'Authorization: TOKEN {{token}}'Response
The identity associated with the profile is deleted.