Return One MongoDB Cloud User in One Organization
/api/atlas/v2/orgs/{orgId}/users/{userId} Returns information about the specified MongoDB Cloud user within the context of the specified organization. To use this resource, the requesting Service Account or API Key must have the Organization Member role.
Note: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the Return One Organization API Key endpoint.
Note: This resource does not return information about pending users invited via the deprecated Invite One MongoDB Cloud User to Join One Project endpoint.
Parameters
path Path Parameters
| Name | Type |
|---|---|
orgId
required
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. | string |
userId
required
Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username. | string |
query Query Parameters
| Name | Type |
|---|---|
envelope Flag that indicates whether Application wraps the response in an | boolean |
pretty Flag that indicates whether the response body should be in the prettyprint format. | boolean |
Responses
OK
Client Errors
Bad Request.
badRequestDetail?:
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}
Unauthorized.
badRequestDetail?:
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}
Forbidden.
badRequestDetail?:
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}
Not Found.
badRequestDetail?:
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}
Server Errors
Internal Server Error.
badRequestDetail?:
detail?: string;
error: number;
errorCode: string;
parameters?: readonly {}[];
reason?: string;
}