latest--mongodb-atlas-teams

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--mongodb-atlas-teams.json
Parent schema serverless-framework-configuration
Type: object

Adds one team to the specified project. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.. Source:- No source definition found, add manually please

Properties

Profile string | Aws_CF_FunctionString

The profile is defined in AWS Secret manager. See Secret Manager Profile setup.

RoleNames string[]

One or more organization- or project-level roles to assign to the MongoDB Cloud user.

OrgId string | Aws_CF_FunctionString

Unique 24-hexadecimal character string that identifies the team.

ProjectId string | Aws_CF_FunctionString

Unique 24-hexadecimal character string that identifies the project.

Name string | Aws_CF_FunctionString

Unique 24-hexadecimal character string that identifies the team.

Usernames string[]

One or more organization- or project-level roles to assign to the MongoDB Cloud user.

Definitions

AtlasUser object
Country string | Aws_CF_FunctionString

Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.

EmailAddress string | Aws_CF_FunctionString

Email address that belongs to the MongoDB Cloud user.

FirstName string | Aws_CF_FunctionString

First or given name that belongs to the MongoDB Cloud user.

Id string | Aws_CF_FunctionString

Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.

LastName string | Aws_CF_FunctionString

Last name, family name, or surname that belongs to the MongoDB Cloud user.

Links object[]

List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.

MobileNumber string | Aws_CF_FunctionString

Mobile phone number that belongs to the MongoDB Cloud user.

Password string | Aws_CF_FunctionString

Password applied with the username to log in to MongoDB Cloud. MongoDB Cloud does not return this parameter except in response to creating a new MongoDB Cloud user. Only the MongoDB Cloud user can update their password after it has been set from the MongoDB Cloud console.

Roles object[]

List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both.

TeamIds string[]

List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.

Username string | Aws_CF_FunctionString

Email address that represents the username of the MongoDB Cloud user.

AtlasRole object
ProjectId string | Aws_CF_FunctionString

Unique 24-hexadecimal digit string that identifies the project to which this role belongs. You can set a value for this parameter or orgId but not both in the same request.

OrgId string | Aws_CF_FunctionString

Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. You can set a value for this parameter or groupId but not both in the same request

RoleName string | Aws_CF_FunctionString

Human-readable label that identifies the collection of privileges that MongoDB Cloud grants a specific API key, MongoDB Cloud user, or MongoDB Cloud team. These roles include organization- and project-level roles.

Organization Roles

  • ORG_OWNER
  • ORG_MEMBER
  • ORG_GROUP_CREATOR
  • ORG_BILLING_ADMIN
  • ORG_READ_ONLY

Project Roles

  • GROUP_CLUSTER_MANAGER
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_ONLY
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_OWNER
  • GROUP_READ_ONLY