Data Access API

Note

Use of this API is dependent on enabling data security. See the associated Data Access Controls and Data Masking guides for details.

Endpoint Index

Action	Endpoint
Add User Data Access	PATCH /auth/users/{locator}/dataaccess/{tenantLocator}
Fetch User Data Access	GET /auth/users/{locator}/dataaccess
Fetch User Data Access for Tenant	GET /auth/users/{locator}/dataaccess/{tenantLocator}
Delete User Data Access	DELETE /auth/users/{locator}/dataaccess/{tenantLocator}

Add User Data Access

addUserDataAccess

PATCH /auth/users/{locator}/dataaccess/{tenantLocator}

Request Parameters:

Name	Position	Type	Required
locator	path	uuid	required
tenantLocator	path	uuid	required

Security Group:users Permission:write

Fetch User Data Access

fetchUserDataAccess

GET /auth/users/{locator}/dataaccess

Request Parameters:

Name	Position	Type	Required
locator	path	uuid	required

Security Group:users Permission:read

Fetch User Data Access for Tenant

fetchUserDataAccessForTenant

GET /auth/users/{locator}/dataaccess/{tenantLocator}

Request Parameters:

Name	Position	Type	Required
locator	path	uuid	required
tenantLocator	path	uuid	required

Security Group:users Permission:read

Delete User Data Access

deleteUserDataAccess

DELETE /auth/users/{locator}/dataaccess/{tenantLocator}

Request Parameters:

Name	Position	Type	Required
locator	path	uuid	required
tenantLocator	path	uuid	required

Response:void

Security Group:users Permission:write

UserDataAccessRequest

required
maskingLevel Enum level1 | level2 | none
accessControlFields map<string,map<string,string[]>>

UserDataAccessResponse

required
tenantLocator uuid
userLocator uuid
maskingLevel Enum level1 | level2 | none
accessControlFields map<string,map<string,string[]>>