Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
Ops Manager Administration API Resources
/
Organizations and Teams
/
Organizations

Get All Organization Invitations

On this page

  • Required Roles
  • Resource
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Example Request
  • Example Response
  • Response Header
  • Response Body

Retrieves all pending invitations to the specified Ops Manager organization.

Required Roles

You can successfully call this endpoint with the Organization User Admin role.

Resource

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /orgs/{ORG-ID}/invites

Request Path Parameters

Path Element
Type
Necessity
Description
ORG-ID
string
Required
Unique 24-hexadecimal digit string that identifies the organization.

Request Query Parameters

Name
Type
Necessity
Description
Default
pretty
boolean
Optional
Flag indicating whether the response body should be in a prettyprint format.
false
envelope
boolean
Optional

Flag that indicates whether or not to wrap the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

Name
Description
status
HTTP response code
envelope
Expected response body
false
username
string
Optional

Email address of the invited user. This is the address to which Ops Manager sent the invite.

If omitted, Ops Manager returns all pending invitations.

Request Body Parameters

This endpoint doesn't use HTTP request body parameters.

Response

The response JSON document includes an array of objects. Each object represents one invitation to the Ops Manager project.

Name
Type
Description
createdAt
string
Timestamp in ISO 8601 date and time format in UTC when Ops Manager sent the invitation.
expiresAt
string

Timestamp in ISO 8601 date and time format in UTC when the invitation expires.

Users have 30 days to accept an invitation to an Ops Manager project.

id
string
Unique 24-hexadecimal digit string that identifies the invitation.
inviterUsername
string
Ops Manager user who invited username to the organization.
orgId
string
Unique 24-hexadecimal digit string that identifies the organization.
orgName
string
Name of the organization.
roles
array of strings

Ops Manager roles to assign to the invited user.

If the user accepts the invitation, Ops Manager assigns these roles to them.

teamIds
array of strings
Unique 24-hexadecimal digit strings that identify the teams that the user was invited to join.
username
string

Email address to which Ops Manager sent the invitation.

If the user accepts the invitation, they use this email address as their Ops Manager username.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
     --header "Accept: application/json" \
     --request GET "https://opsmanager.example.com/api/public/v1.0/orgs/{ORG-ID}/invites?pretty=true"

Example Response

Response Header

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

1[
2  {
3    "createdAt": "2021-02-18T18:51:46Z",
4    "expiresAt": "2021-03-20T18:51:46Z",
5    "id": "{INVITATION-ID-1}",
6    "inviterUsername": "admin@example.com",
7    "orgId": "{ORG-ID}",
8    "orgName": "{ORG-NAME}",
9    "roles": [
10      "GROUP_OWNER"
11    ],
12    "teamIds": [],
13    "username": "jane.smith@example.com"
14  },
15  {
16    "createdAt": "2021-02-18T21:28:38Z",
17    "expiresAt": "2021-03-20T21:28:38Z",
18    "id": "{INVITATION-ID-2}",
19    "inviterUsername": "admin@example.com",
20    "orgId": "{ORG-ID}",
21    "orgName": "{ORG-NAME}",
22    "roles": [
23      "ORG_MEMBER"
24    ],
25    "teamIds": [],
26    "username": "john.smith@example.com"
27  },
28  {
29    "createdAt": "2021-02-18T21:05:40Z",
30    "expiresAt": "2021-03-20T21:05:40Z",
31    "id": "{INVITATION-ID-3}",
32    "inviterUsername": "admin@example.com",
33    "orgId": "{ORG-ID}",
34    "orgName": "{ORG-NAME}",
35    "roles": [
36      "ORG_MEMBER"
37    ],
38    "teamIds": [],
39    "username": "wyatt.smith@example.com"
40  }
41]

Back

Delete One Organization Invitation

Next

Get One Organization Invitation