Skip to main content
POST
Update access filters for a data product role

Authorizations

Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Scopes

https://{cluster}.cognitedata.com/.default
oidc-token
https://{cluster}.cognitedata.com/.default
oauth2-client-credentials
https://api.cognitedata.com/.default
oauth2-open-industrial-data
https://{cluster}.cognitedata.com/.default
oauth2-auth-code

Path Parameters

externalId
string
required

Data product external identifier

Required string length: 1 - 100
Pattern: ^[a-z]([a-z0-9_-]{0,98}[a-z0-9])?$

Body

application/json

Incrementally adds, updates, or removes access filters for the role identified by roleExternalId.

roleExternalId
string
required

The external ID of the data product role. Uniquely identifies the role within its data product.

Required string length: 1 - 50
Pattern: ^[a-zA-Z]([a-zA-Z0-9_-]{0,48}[a-zA-Z0-9])?$
add
object[]

Adds a new access filter. If an access filter for the same view already exists, the request fails.

Required array length: 1 element
Example:
update
object[]

Updates an existing access filter identified by its view. The access filter must already exist.

Required array length: 1 element
Example:
remove
object[]

Removes the access filter whose view matches the provided reference. Access filters that are not currently present are silently ignored.

Required array length: 1 element
Example:

Response

The updated access filters for the role.

items
object[]
required