atlas api mongoDbCloudUsers updateOrganizationUser
On this page
experimental: Updates one MongoDB Cloud user in the specified organization.
You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role. Note: Only include the fields you wish to update in the request body. Supplying a field with an empty value will reset that field on the user. Note: This resource cannot be used to update pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint. This command is invoking the endpoint with OperationID: 'updateOrganizationUser'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Users/operation/updateOrganizationUser
Syntax
atlas api mongoDbCloudUsers updateOrganizationUser [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--envelope | false | flag that indicates whether Application wraps the response in an envelope JSON object | |
--file | string | false | path to the file which contains the api request contents |
-h, --help | false | help for updateOrganizationUser | |
--orgId | string | true | unique 24-hexadecimal digit string that identifies the organization that contains your projects |
--output | string | false | preferred api format, can be ["json", go-template] This value defaults to "json". |
--output-file | string | false | file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) |
--pretty | false | flag that indicates whether the response body should be in the prettyprint format | |
--userId | string | true | unique 24-hexadecimal digit string that identifies the pending or active user in the organization |
--version | string | false | api version to use when calling the api call [options: "2043-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2043-01-01". |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |