Update access group scope.

Request

Security

ApiKeyAuth

Path

accessGroupIdstring, non-emptyrequired

The ID of the Access group.

scopeIdstring, non-emptyrequired

The ID of the Access group scope.

Bodyapplication/jsonrequired

Access group scope to update.

namestring, [ 1 .. 256 ] characters

The Access group scope name.

scope_typestring

Specifies the type of the scope. Scope of type SIMPLE would grant access to all DCT objects. Scope of type SCOPED would grant access to all objects based on objects and object-tags and permissions defined in linked role. Scope of type ADVANCED would grant access to DCT objects based on objects and object-tags and the individual permissions.

Enum:"SIMPLE""SCOPED""ADVANCED"

Example:"SCOPED"

curl -i -X PATCH \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/22.0.0/continuous-data-apis-dct-22.0.0/access-groups/{accessGroupId}/scopes/{scopeId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "scope_type": "SCOPED"
  }'

Responses

The updated access group scope.

Bodyapplication/json

idstringread-only

The Access group scope ID.

namestring, [ 1 .. 256 ] characters

The Access group scope name.

role_idstring, [ 1 .. 256 ] charactersrequired

The Access group role id.

scope_typestring

Specifies the type of the scope. Scope of type SIMPLE would grant access to all DCT objects. Scope of type SCOPED would grant access to all objects based on objects and object-tags and permissions defined in linked role. Scope of type ADVANCED would grant access to DCT objects based on objects and object-tags and the individual permissions.

Enum:"SIMPLE""SCOPED""ADVANCED"

Example:"SCOPED"

object_tagsArray of objects(ScopeTag)

The permissions in this access group scope will be granted to all DCT objects tagged with tags matching this property. This is cumulative with objects defined in the 'objects' property, and mutually exclusive with scope_type 'SIMPLE'.

objectsArray of objects(ScopedObjectItem)

The permissions in this access group scope will be granted to all DCT objects with matching object id and object type, mutually exclusive with scope_type 'SIMPLE'.

always_allowed_permissionsArray of objects(AlwaysAllowedPermission)

An array of always allowed permissions which can be used to specify object type and permission. An object with same object type and permission can not be added in 'objects' array.

Response

{
  "id": "string",
  "name": "string",
  "role_id": "string",
  "scope_type": "SCOPED",
  "object_tags": [
    { … }
  ],
  "objects": [
    { … }
  ],
  "always_allowed_permissions": [
    { … }
  ]
}