GetUserDetails - Amazon CodeCatalyst

GetUserDetails

Returns information about a user.

Request Syntax

GET /userDetails?id=id&userName=userName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

id

The system-generated unique ID of the user.

Length Constraints: Minimum length of 1. Maximum length of 256.

userName

The name of the user as displayed in Amazon CodeCatalyst.

Length Constraints: Minimum length of 3. Maximum length of 100.

Pattern: [a-zA-Z0-9_.-]{3,100}

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "displayName": "string", "primaryEmail": { "email": "string", "verified": boolean }, "userId": "string", "userName": "string", "version": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

displayName

The friendly name displayed for the user in Amazon CodeCatalyst.

Type: String

primaryEmail

The email address provided by the user when they signed up.

Type: EmailAddress object

userId

The system-generated unique ID of the user.

Type: String

userName

The name of the user as displayed in Amazon CodeCatalyst.

Type: String

version

Type: String

Errors

AccessDeniedException

The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.

HTTP Status Code: 403

ConflictException

The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.

HTTP Status Code: 409

ResourceNotFoundException

The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.

HTTP Status Code: 404

ServiceQuotaExceededException

The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: