Socotra
API ReferenceConfiguration and Development API

Data Access Controls API

The API endpoints below have been deprecated and will be removed in a future release.

ActionEndpoint
Add Data Security MaskPATCH/auth/users/{locator}/accessmask
Fetch User MaskGET/auth/users/{locator}/accessmask/{tenantLocator}/{type}
Fetch User MasksGET/auth/users/{locator}/accessmask
Fetch User Masks For TenantGET/auth/users/{locator}/accessmask/{tenantLocator}
Delete User MasksDELETE/auth/users/{locator}/accessmask/{tenantLocator}

Add Data Security Mask

Add Data Security MaskaddDataSecurityMaskDeprecated
PATCH/auth/users/{locator}/accessmask

Parameters

NameInTypeRequiredDescription
locatorpathuuidYes
Security Group:users
Permission:
write

Fetch User Mask

Fetch User MaskfetchUserMaskDeprecated
GET/auth/users/{locator}/accessmask/{tenantLocator}/{type}

Parameters

NameInTypeRequiredDescription
locatorpathuuidYes
tenantLocatorpathuuidYes
typepathEnum account | policyYes
Security Group:users
Permission:
read

Fetch User Masks

Fetch User MasksfetchUserMasksDeprecated
GET/auth/users/{locator}/accessmask

Parameters

NameInTypeRequiredDescription
locatorpathuuidYes
Security Group:users
Permission:
read

Fetch User Masks For Tenant

Fetch User Masks For TenantfetchUserMasksForTenantDeprecated
GET/auth/users/{locator}/accessmask/{tenantLocator}

Parameters

NameInTypeRequiredDescription
locatorpathuuidYes
tenantLocatorpathuuidYes
Security Group:users
Permission:
read

Delete User Masks

Delete User MasksdeleteUserMasksDeprecated
DELETE/auth/users/{locator}/accessmask/{tenantLocator}

Parameters

NameInTypeRequiredDescription
locatorpathuuidYes
tenantLocatorpathuuidYes
Response:void
Security Group:users
Permission:
write
UserDataSecurityMaskRequest

Required properties

PropertyTypeDescription
tenantLocatoruuid
typeEnum account | policy
fieldsmap<string, string[]>
UserDataAccessControlMaskResponse

Required properties

PropertyTypeDescription
tenantLocatoruuid
userLocatoruuid
maskTypeEnum account | policy
fieldsmap<string, string[]>

See Also

On this page