Skip to main content

Replace a permission set.

PUT 
/v1/catalogs/:catalogId/models/:modelId/permission-sets/:permissionSetId

Every field in the body is authoritative: scopes, users and groups that are not listed are removed from the set. The names accepted here come from the Identities endpoints: getUsers returns the userName values valid in users, and getGroups the name values valid in groups. A username or group name that does not exist in the identity provider is ignored rather than rejected, and the rest of the set is still applied. Read the set back to confirm which principals were granted.

Request​

Path Parameters

    catalogId stringrequired

    Identifier of the catalog.

    modelId stringrequired

    Identifier of the model within the catalog.

    permissionSetId stringrequired

    Identifier of the permission set.

Header Parameters

    Authorization string

Body

required

    name stringrequired

    Possible values: non-empty

    Display name of the permission set. Not required to be unique within the model.

    scopes string[]required

    Possible values: [ctas, discovery, query], >= 1

    Operations the listed principals may perform on the model. ctas allows aggregate creation, discovery allows the model to be listed and browsed, query allows queries against it.

    users string[]

    Possible values: non-empty

    Default value: ``

    Usernames granted the listed scopes. A username that does not exist in the identity provider is ignored; see the operation description.

    groups string[]

    Possible values: non-empty

    Default value: ``

    Group names granted the listed scopes. A group that does not exist in the identity provider is ignored; see the operation description.

Responses​

The permission set has been replaced.

Loading...