v47

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2024-10-01163166522.3 KB

Acls

Create acl

Create a new acl. If there is an existing acl with the same contents as the one specified in the request, will return the existing acl unmodified

post/v1/acl

Request body

object_type'organization' | 'project' | 'experiment' | 'dataset' | 'prompt' | 'prompt_session' | 'group' | 'role' | 'org_member' | 'project_log' | 'org_project' required

The object type that the ACL applies to

object_idstring uuid required

The id of the object the ACL applies to

user_idstring uuid nullable

Id of the user the ACL applies to. Exactly one of user_id and group_id will be provided

group_idstring uuid nullable

Id of the group the ACL applies to. Exactly one of user_id and group_id will be provided

permission'create' | 'read' | 'update' | 'delete' | 'create_acls' | 'read_acls' | 'update_acls' | 'delete_acls' nullable

Permission the ACL grants. Exactly one of permission and role_id will be provided

restrict_object_type'organization' | 'project' | 'experiment' | 'dataset' | 'prompt' | 'prompt_session' | 'group' | 'role' | 'org_member' | 'project_log' | 'org_project' nullable

When setting a permission directly, optionally restricts the permission grant to just the specified object type. Cannot be set alongside a role_id.

role_idstring uuid nullable

Id of the role the ACL grants. Exactly one of permission and role_id will be provided

Response

Returns the new acl object

idstring uuid required

Unique identifier for the acl

object_type'organization' | 'project' | 'experiment' | 'dataset' | 'prompt' | 'prompt_session' | 'group' | 'role' | 'org_member' | 'project_log' | 'org_project' required

The object type that the ACL applies to

object_idstring uuid required

The id of the object the ACL applies to

user_idstring uuid nullable

Id of the user the ACL applies to. Exactly one of user_id and group_id will be provided

group_idstring uuid nullable

Id of the group the ACL applies to. Exactly one of user_id and group_id will be provided

permission'create' | 'read' | 'update' | 'delete' | 'create_acls' | 'read_acls' | 'update_acls' | 'delete_acls' nullable

Permission the ACL grants. Exactly one of permission and role_id will be provided

restrict_object_type'organization' | 'project' | 'experiment' | 'dataset' | 'prompt' | 'prompt_session' | 'group' | 'role' | 'org_member' | 'project_log' | 'org_project' nullable

When setting a permission directly, optionally restricts the permission grant to just the specified object type. Cannot be set alongside a role_id.

role_idstring uuid nullable

Id of the role the ACL grants. Exactly one of permission and role_id will be provided

_object_org_idstring uuid required

The organization the ACL's referred object belongs to

createdstring date-time nullable

Date of acl creation