1. Overview

These services verify if a specific user or user group can access a type or an attribute, and if the user or user group has global or catalog-specific permissions.

1.1. Version information

Version : 1.0.0

1.2. License information

License : Use of this file is subject to the terms of your agreement with SAP SE or its affiliates respecting the use of the SAP product for which this file relates.
Terms of service : null

1.3. URI scheme

Host : localhost:9001
BasePath : /permissionswebservices

1.4. Tags

  • Permissions : Get permissions for principal

1.5. Produces

  • application/xml

  • application/json

2. Security

2.1. oauth2_password

Type : oauth2
Flow : password
Token URL : /authorizationserver/oauth/token

Name

permissionswebservices

2.2. oauth2_client_credentials

Type : oauth2
Flow : application
Token URL : /authorizationserver/oauth/token

Name

permissionswebservices

3. Resources

3.1. Permissions

Get permissions for principal

3.1.1. Get Attributes Permissions

GET /v1/permissions/principals/{principalUid}/attributes
Description

Endpoint to retrieve attributes permissions for a principal. This will look in the principal hierarchy

Parameters
Type Name Description Schema Default

Path

principalUid
required

Principal identifier

string

Query

attributes
required

Attribute names separated by comma. Attribute name format : ItemTypeName.AttributeName (e.g. User.name)

string

Query

fields
optional

Response configuration

string

"DEFAULT"

Query

permissionNames
required

Permission names separated by comma

string
Responses
HTTP Code Description Schema

200

OK

PermissionsList

400

Bad Request e.g. incorrect parameter value

No Content

401

Unauthorized

No Content

403

Forbidden. Have no access to this endpoint or no access to principal’s permissions

No Content
Security
Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

3.1.2. Get Catalog Permissions

GET /v1/permissions/principals/{principalUid}/catalogs
Description

Endpoint to retrieve catalog permissions for a principal. This will look in the principal hierarchy.

Parameters
Type Name Description Schema Default

Path

principalUid
required

Principal identifier

string

Query

catalogId
required

Catalog identifiers separated by comma

string

Query

catalogVersion
required

Catalog version identifiers separated by comma

string

Query

fields
optional

Response configuration

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

CatalogPermissionsList

400

Bad Request e.g. incorrect parameter value

No Content

401

Unauthorized

No Content

403

Forbidden. Have no access to this endpoint or no access to principal’s permissions

No Content
Security
Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

3.1.3. Get Global Permissions

GET /v1/permissions/principals/{principalUid}/global
Description

Endpoint to retrieve global permissions for a principal. This will look in the principal hierarchy

Parameters
Type Name Description Schema Default

Path

principalUid
required

Principal identifier

string

Query

fields
optional

Response configuration

string

"DEFAULT"

Query

permissionNames
required

Permission names separated by comma

string
Responses
HTTP Code Description Schema

200

OK

Permissions

400

Bad Request e.g. incorrect parameter value

No Content

401

Unauthorized

No Content

403

Forbidden. Have no access to this endpoint or no access to principal’s permissions

No Content
Security
Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

3.1.4. Get Types Permissions

GET /v1/permissions/principals/{principalUid}/types
Description

Endpoint to retrieve types permissions for a principal. This will look in the principal hierarchy

Parameters
Type Name Description Schema Default

Path

principalUid
required

Principal identifier

string

Query

fields
optional

Response configuration

string

"DEFAULT"

Query

permissionNames
required

Permission names separated by comma

string

Query

types
required

Type names separated by comma

string
Responses
HTTP Code Description Schema

200

OK

PermissionsList

400

Bad Request e.g. incorrect parameter value

No Content

401

Unauthorized

No Content

403

Forbidden. Have no access to this endpoint or no access to principal’s permissions

No Content
Security
Type Name

oauth2

oauth2_client_credentials

oauth2

oauth2_password

4. Definitions

4.1. CatalogPermissions

Permissions for catalog

Name Description Schema

catalogId
required

Catalog identifier

string

catalogVersion
required

Catalog version identifier

string

permissions
optional

Permissions map

< string, string > map

syncPermissions
optional

Sync Permissions list

< SyncPermissions > array

4.2. CatalogPermissionsList

Catalog permissions list

Name Schema

permissionsList
optional

< CatalogPermissions > array

4.3. Permissions

Permissions for principal

Name Description Schema

id
required

Principal identifier

string

permissions
optional

Permissions map.

< string, string > map

4.4. PermissionsList

List of permissions

Name Schema

permissionsList
optional

< Permissions > array

4.5. SyncPermissions

Sync permission

Name Schema

canSynchronize
optional

boolean

targetCatalogVersion
optional

string