Role and User Management APIs

You will get to know more about the APIs used to manage roles, users, groups, and permission assignments.

Table 1. APIs to manage Roles, Users, Groups, and Permissions
Specific Area of Impact API Name/Link to the API API Request Description Method
Reltio Services Management Get all registered Reltio services GET {oauth_uri}/reltioservices Returns the registered Reltio services/resources that the user has access to GET
Reltio Services Management Get registered Reltio service by Service ID GET {oauth_uri}/reltioservices/{serviceId} Returns the registered Reltio service/resources based on the Service ID. The response depends on the existing role that the user has. GET
Permissions Management Get Permissions By Role Name (System Roles) GET {oauth_uri}/roles/permissions/{roleName} Returns the permissions JSON of the role sent in the request. GET
Permission Management - Customer Specific role Get All Customer Roles Permissions GET {oauth_uri}/customers/{customerId}/roles/permissions Returns all the roles' permissions configured for the customer GET
Permission Management - Customer Specific role Get Permissions By Role Name GET {oauth_uri}/customers/{customerId}/roles/permissions/{roleName} Returns the permissions JSON of the role sent in the request. GET
Permission Management - Customer Specific role Assign Permissions for existing Customer Specific Role POST {oauth_uri}/customers/{customerId}/roles/permissions Assigns permissions to a customer specific role. The request body is an array with one or more Customer specific Roles Permissions objects. POST
Permission Management - Customer Specific role Update Permissions of Customer Specific Role PUT {oauth_uri}/customers/{customerId}/roles/permissions/{roleName} Updates the existing permissions of a role by specifying the required permissions in the request body. PUT
User Management Get Users GET {oauth_uri}/users/ Returns all the users from the Auth server. The Roles/Tenants are available in the new format in the userPermissions property. GET
User Management Create Users POST {oauth_uri}/users Creates one or more users as specified in the request body. The roles and tenants must be specified in the new format under the userPermissions property. Request body must be an array with Reltio user object. POST
User Management Update Users PUT {oauth_uri}/users/{userName} Overrides the users completely with the data sent in the request body. The roles and tenants must be specified in the new format under the userPermissions property. Request body must be an array with Reltio user object. PUT
Customer Management Get Users of a Customer GET {oauth_uri}/customers/{customerId}/users Returns all the users belonging to the specific customer. Only Customer Administrators can use this API. GET
Groups Management Get all Customer Groups GET {oauth_uri}/customers/{customerId}/groups Returns all the Groups created for the Customer. GET
Groups Management Get Group by ID GET {oauth_uri}/customers/{customerId}/groups/{groupId} Returns the specific group under the customer based on the group ID. GET
Groups Management Create Groups POST {oauth_uri}/customers/{customerId}/groups Creates the groups with the tenant specific roles configured for the customer. Request body must be an array with group details. POST
Groups Management Update Groups PUT {oauth_uri}/customers/{customerId}/groups/{groupId} Updates the group with the JSON object sent in the request body. PUT
Groups Management Delete Groups DELETE {oauth_uri}/customers/{customerId}/groups/{groupId} Deletes the group from the customer. DELETE