Entity Admin

An API Product to manage users and their access to functionalities in a given workspace

An entity with the Entity Admin function assigned is able to:

  • view all the users registered in current workspace (tenancy), and their details

  • activate/disable (block/unblock) any of those users

  • view all the functions associated with all the packages, mapped to all client-tenant linkages, or functions that can be directly-assigned in current tenant ("tenant-functions")

  • view all the functions assigned to a given entity in current tenant

  • directly-assign and manage functions to that entity

The Entity Admin API Product exposes API Endpoints that allow an application to manage users, and their access to functionalities in a certain workspace.

API Endpoints in this API Product are exposed by the Identity Service (IDT)

User management Endpoints:



Retrieve the list off all users registered in current workspace -

GET {Apigee domain}/{IDT proxy}/v2/admin/users



Disable / Activate users -

PATCH {Apigee domain}/{IDT proxy}/v1/admin/users/{userId}

Entity access management Endpoints:



Retrieve the list of functions that can be directly-assigned to entities in current workspace -

GET {Apigee domain}/{IDT proxy}/v1/admin/assignable-functions



Retrieve the list of functions that are directly-assigned to a given entity in current workspace -

GET {Apigee domain}/{IDT proxy}/v1/admin/entities/{entityId}/assigned-functions



Directly-assign and manage functions to a given entity in current workspace -

PUT {Apigee domain}/{IDT proxy}/v1/admin/entities/{entityId}/assigned-functions