GrantPrivilege()

Grants a privilege on a resource to a role.

pub async fn grant_privilege(&self, request: GrantPrivilegeRequest) -> Result<()>

Collection-scoped grants use the v2 privilege RPC; grants configured with the legacy object_type/object_name surface (for example USER objects or explicit GLOBAL scope) use the v1 OperatePrivilege RPC. The two surfaces are mutually exclusive.

Request Syntax

let request = GrantPrivilegeRequest::builder()
    .role_name("analyst")
    .database_name("default")
    .collection_name("books")
    .privilege("Search")
    .build()?;

REQUEST FIELDS:

• role_name: String

  Name of the role receiving the privilege. Required.

• database_name: String

  Database that owns the target resource. Required.

• collection_name: String

  Name of the collection the privilege applies to. Required unless the legacy object_type/object_name surface is used.

• privilege: String

  Name of the privilege to grant, for example Search, Query, or Insert. Required.

• object_type: Option<String>

  Legacy v1 object type, for example User or Global. Must be paired with object_name; mutually exclusive with collection_name.

• object_name: Option<String>

  Legacy v1 object name. Must be paired with object_type; mutually exclusive with collection_name.

RETURN TYPE:

Result<()>

RETURNS:

Returns Ok(()) on success; returns an Error on failure.

Example

let request = GrantPrivilegeRequest::builder()
    .role_name("analyst")
    .database_name("default")
    .collection_name("books")
    .privilege("Search")
    .build()?;
client.grant_privilege(request).await?;