Corpus Permissions

Method: corpora.permissions.create

Create a permission to a specific resource.

Endpoint

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/permissions

Path parameters

parent string

Required. The parent resource of the Permission. Formats: tunedModels/{tunedModel} corpora/{corpus} It takes the form corpora/{corpora}.

Request body

The request body contains an instance of Permission.

Fields
granteeType enum (GranteeType)

Optional. Immutable. The type of the grantee.

emailAddress string

Optional. Immutable. The email address of the user of group which this permission refers. Field is not set when permission's grantee type is EVERYONE.

role enum (Role)

Required. The role granted by this permission.

Example request

Python

model_info = genai.get_model("tunedModels/my-increment-model")
# ...

public_permission = model_info.permissions.create(
    role="READER",
    grantee_type="EVERYONE",
)

group_permission = model_info.permissions.create(
    role="READER",
    # Use "user" for an individual email address.
    grantee_type="group",
    email_address="genai-samples-test-group@googlegroups.com",
)
tuned_models.py

Response body

If successful, the response body contains a newly created instance of Permission.

Method: corpora.permissions.list

Lists permissions for the specific resource.

Endpoint

get https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/permissions

Path parameters

parent string

Required. The parent resource of the permissions. Formats: tunedModels/{tunedModel} corpora/{corpus} It takes the form corpora/{corpora}.

Query parameters

pageSize integer

Optional. The maximum number of Permissions to return (per page). The service may return fewer permissions.

If unspecified, at most 10 permissions will be returned. This method returns at most 1000 permissions per page, even if you pass larger pageSize.

pageToken string

Optional. A page token, received from a previous permissions.list call.

Provide the pageToken returned by one request as an argument to the next request to retrieve the next page.

When paginating, all other parameters provided to permissions.list must match the call that provided the page token.

Request body

The request body must be empty.

Example request

Python

model_info = genai.get_model("tunedModels/my-increment-model")

# ...

for p in model_info.permissions.list():
    print(p)
tuned_models.py

Response body

If successful, the response body contains an instance of ListPermissionsResponse.

Method: corpora.permissions.get

Gets information about a specific Permission.

Endpoint

get https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/permissions/*}

Path parameters

name string

Required. The resource name of the permission.

Formats: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} It takes the form corpora/{corpora}/permissions/{permission}.

Request body

The request body must be empty.

Example request

Python

model_info = genai.get_model("tunedModels/my-increment-model")

# ...

public = model_info.permissions.create(
    role="READER",
    grantee_type="EVERYONE",
)
print(public)
name = public.name
print(name)  # tunedModels/{tunedModel}/permissions/{permission}

from_name = genai.types.Permissions.get(name)
print(from_name)
tuned_models.py

Response body

If successful, the response body contains an instance of Permission.

Method: corpora.permissions.patch

Updates the permission.

Endpoint

patch https://generativelanguage.googleapis.com/v1beta/{permission.name=corpora/*/permissions/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{permission.name=corpora/*/permissions/*}

Path parameters

permission.name string

Output only. Identifier. The permission name. A unique name will be generated on create. Examples: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Output only. It takes the form corpora/{corpora}/permissions/{permission}.

Query parameters

updateMask string (FieldMask format)

Required. The list of fields to update. Accepted ones: - role (Permission.role field)

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Permission.

Fields
role enum (Role)

Required. The role granted by this permission.

Example request

Python

        model_info = genai.get_model("tunedModels/my-increment-model")

        # ...

        test_group = model_info.permissions.create(
            role="writer",
            grantee_type="group",
            email_address="genai-samples-test-group@googlegroups.com",
        )

        test_group.update({"role": "READER"})

    def test_tuned_models_permission_delete(self):
        model_info = genai.get_model("tunedModels/my-increment-model")
        # ...

        public_permission = model_info.permissions.create(
            role="READER",
            grantee_type="EVERYONE",
        )

        public_permission.delete()


if __name__ == "__main__":
    absltest.main()

tuned_models.py

Response body

If successful, the response body contains an instance of Permission.

Method: corpora.permissions.delete

Deletes the permission.

Endpoint

delete https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/permissions/*}

Path parameters

name string

Required. The resource name of the permission. Formats: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} It takes the form corpora/{corpora}/permissions/{permission}.

Request body

The request body must be empty.

Example request

Python

model_info = genai.get_model("tunedModels/my-increment-model")
# ...

public_permission = model_info.permissions.create(
    role="READER",
    grantee_type="EVERYONE",
)

public_permission.delete()
tuned_models.py

Response body

If successful, the response body is empty.

REST Resource: corpora.permissions

Resource: Permission

Permission resource grants user, group or the rest of the world access to the PaLM API resource (e.g. a tuned model, corpus).

A role is a collection of permitted operations that allows users to perform specific actions on PaLM API resources. To make them available to users, groups, or service accounts, you assign roles. When you assign a role, you grant permissions that the role contains.

There are three concentric roles. Each role is a superset of the previous role's permitted operations:

  • reader can use the resource (e.g. tuned model, corpus) for inference
  • writer has reader's permissions and additionally can edit and share
  • owner has writer's permissions and additionally can delete
Fields
name string

Output only. Identifier. The permission name. A unique name will be generated on create. Examples: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Output only.

granteeType enum (GranteeType)

Optional. Immutable. The type of the grantee.

emailAddress string

Optional. Immutable. The email address of the user of group which this permission refers. Field is not set when permission's grantee type is EVERYONE.

role enum (Role)

Required. The role granted by this permission.

JSON representation 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

Defines types of the grantee of this permission.

Enums
GRANTEE_TYPE_UNSPECIFIED The default value. This value is unused.
USER Represents a user. When set, you must provide emailAddress for the user.
GROUP Represents a group. When set, you must provide emailAddress for the group.
EVERYONE Represents access to everyone. No extra information is required.

Role

Defines the role granted by this permission.

Enums
ROLE_UNSPECIFIED The default value. This value is unused.
OWNER Owner can use, update, share and delete the resource.
WRITER Writer can use, update and share the resource.
READER Reader can use the resource.

ListPermissionsResponse

Response from ListPermissions containing a paginated list of permissions.

Fields
permissions[] object (Permission)

Returned permissions.

nextPageToken string

A token, which can be sent as pageToken to retrieve the next page.

If this field is omitted, there are no more pages.

JSON representation 
{
  "permissions": [
    {
      object (Permission)
    }
  ],
  "nextPageToken": string
}