Skip to main content

removeUserFromRole()

Addedv2.4.x

This operation removes a user from a specific role.

await milvusClient.removeUserFromRole(data)

Request Syntax

await milvusClient.removeUserFromRole({
username: string,
rolename: string,
timeout?: number
})

PARAMETERS:

  • username (string) -

    [REQUIRED]

    The name of a user.

  • rolename (string) -

    [REQUIRED]

    The name of a role

  • timeout (number) -

    The timeout duration for this operation.

    Setting this to None indicates that this operation timeouts when any response arrives or any error occurs.

RETURNS Promise<ResStatus>

This method returns a promise that resolves to a ResStatus object.

{
code: number,
error_code: string | number,
reason: string
}

PARAMETERS:

  • code (number) -

    A code that indicates the operation result. It remains 0 if this operation succeeds.

  • error_code (string | number) -

    An error code that indicates an occurred error. It remains Success if this operation succeeds.

  • reason (string) -

    The reason that indicates the reason for the reported error. It remains an empty string if this operation succeeds.

Example

await milvusClient.removeUserFromRole({
username: 'my',
roleName: 'myrole'
});