Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Managed Service for MongoDB API, REST: User.GrantPermission

Written by
Updated at October 17, 2024

Grants permission to the specified MongoDB user.

HTTP request

POST https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/{clusterId}/users/{userName}:grantPermission

Path parameters

Field

Description

clusterId

string

Required field. ID of the MongoDB cluster the user belongs to.
To get the cluster ID, use a ClusterService.List request.

userName

string

Required field. Name of the user to grant the permission to.
To get the name of the user, use a UserService.List request.

Body parameters

{
  "permission": {
    "databaseName": "string",
    "roles": [
      "string"
    ]
  }
}

Field

Description

permission

Permission

Required field. Permission that should be granted to the specified user.

Permission

Field

Description

databaseName

string

Name of the database that the permission grants access to.

roles[]

string

MongoDB roles for the databaseName database that the permission grants.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "clusterId": "string",
    "userName": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "name": "string",
    "clusterId": "string",
    "permissions": [
      {
        "databaseName": "string",
        "roles": [
          "string"
        ]
      }
    ]
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

GrantUserPermissionMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

User

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

GrantUserPermissionMetadata

Field

Description

clusterId

string

ID of the MongoDB cluster the user belongs to.
To get the cluster ID, use a ClusterService.List request.

userName

string

Name of the user that is being granted a permission.

Status

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

User

A MongoDB User resource. For more information, see the
Developer's Guide.

Field

Description

name

string

Name of the MongoDB user.

clusterId

string

ID of the MongoDB cluster the user belongs to.

permissions[]

Permission

Set of permissions granted to the user.

Permission

Field

Description

databaseName

string

Name of the database that the permission grants access to.

roles[]

string

MongoDB roles for the databaseName database that the permission grants.
Previous
Delete
Next
RevokePermission