...
The CoreOne Suite offers an extensive access management. In the domain of this access management, permissions are called resource assignments. So whenever Whenever an administrator is assigning a resource in the Admin UI, when a user receives resources through a assignment rule, or someone uses the self-service portal to delegate a service permission or a service permission of a company to someone else, those permissions are stored in the access management space as resource assignments.
...
It is important to note that calls to api/permission do not read the access management space (IAM space) but the actually provisioned resources at the CoreOne Authentication Service (IdP space). For example if a user has access to a role, but that assignment was paused, the assignment will show up in the IAM space (resource assignment) but is not provisioned to the CoreOne Authentication Service (IdP space) and will not show up over the permission API, as the user currently does not have that permission.
Base URL
The base URL for the permission API is as following:
| Code Block |
|---|
{authentication service url}/api |
Endpoints
There are two different endpoints. Depending on your use case, you might choose either one of those.
Generic permissions
Available from version 8.0 and upwards.
| Code Block |
|---|
{authentication service url}/api/permission |
To access this endpoint, you need to have the CoreOne Authentication Service API Read Permissions for any Application assigned to your user. The endpoint itself can return all permission of all applications.
Application Specific Permissions
Available from version 9.0.3 and upwards.
| Code Block |
|---|
{authentication service url}/api/permission/myapplication |
To access this endpoint, you need to have the CoreOne Authentication Service API Read Permissions for My Application assigned to your user. The endpoint itself only returns permissions associated to client calling the endpoint, thus restricting the permissions. In most use cases it’s advised to use this endpoint.
Authentication
In order to access the API, you will need to configure an appropriate client of the CoreOne Suite application and assign the cos_auth_api scope. Additionally you will need an appropriate user with permissions to access the data, that’s either the CoreOne Authentication Service API Read Permissions for any Application or the CoreOne Authentication Service API Read Permissions for My Application resource. Authentication then is done by passing a bearer token in each request. Also note that in order to receive the email address of a user, the client needs to have access to the email scope.
...
| Code Block |
|---|
{authentication service url}/api/permission?contextType=User&contextObjectIdentifier=17175&application=trusteeApp |
or
| Code Block |
|---|
{authentication service url}/api/permission/myapplication?contextType=User&contextObjectIdentifier=17175 |
Property | Data Type | Example | Description |
|---|---|---|---|
| String |
| Set this to |
| String |
| This is dependent on how the user is stored. By default it’s the user id. But if any token transformation has been applied, this might also be the users email or any other unique attribute. |
| String |
| The name of the application to which the permission have to belong |
...
| Code Block |
|---|
{authentication service url}/api/permission?contextType=OrganizationUnit&contextObjectIdentifier=5445&application=trusteeApp |
or
| Code Block |
|---|
{authentication service url}/api/permission/myapplication?contextType=OrganizationUnit&contextObjectIdentifier=5445 |
Property | Data Type | Example | Description |
|---|---|---|---|
| String |
| Set this to |
| String |
| This is dependent on how the organization is stored. By default it’s the organization unit id. But if any token transformation has been applied, this might also be the companies UID or any other unique attribute. |
| String |
| The name of the application to which the permission have to belong |
...
| Code Block |
|---|
{authentication service url}/api/permission?application=Trustee Test Application&userSubject=c1s:17173 |
or
| Code Block |
|---|
{authentication service url}/api/permission/myapplication?userSubject=c1s:17173 |
Property | Data Type | Example | Description |
|---|---|---|---|
| String |
| The name of the application to which the permission have to belong |
| String |
| The subject of the user. This is usually used when the user is logged in, so the subject can be taken directly from the token. |