Data Access API
Use of this API is dependent on enabling data security. See the associated Data Access Controls and Data Masking guides for details.
| 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
Add User Data Access
addUserDataAccessPATCH
/auth/users/{locator}/dataaccess/{tenantLocator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
locator | path | uuid | Yes | |
tenantLocator | path | uuid | Yes |
Fetch User Data Access
Fetch User Data Access
fetchUserDataAccessGET
/auth/users/{locator}/dataaccessParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
locator | path | uuid | Yes |
Response:
UserDataAccessResponse[]Security Group:
usersPermission:
readFetch User Data Access For Tenant
Fetch User Data Access For Tenant
fetchUserDataAccessForTenantGET
/auth/users/{locator}/dataaccess/{tenantLocator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
locator | path | uuid | Yes | |
tenantLocator | path | uuid | Yes |
Response:
UserDataAccessResponseSecurity Group:
usersPermission:
readDelete User Data Access
Delete User Data Access
deleteUserDataAccessDELETE
/auth/users/{locator}/dataaccess/{tenantLocator}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
locator | path | uuid | Yes | |
tenantLocator | path | uuid | Yes |
Response:
voidSecurity Group:
usersPermission:
writeUserDataAccessRequest
Required properties
| Property | Type | Description |
|---|---|---|
maskingLevel | Enum none | level1 | level2 | |
accessControlFields | map<string, map<string, string[]>> |
UserDataAccessResponse
Required properties
| Property | Type | Description |
|---|---|---|
tenantLocator | uuid | |
userLocator | uuid | |
maskingLevel | Enum none | level1 | level2 | |
accessControlFields | map<string, map<string, string[]>> |