CreateUserProfile
Creates a profile for a user that includes user preferences, such as the display name and email address assocciated with the user, in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar.
Request Syntax
{
"displayName": "string
",
"emailAddress": "string
",
"sshPublicKey": "string
",
"userArn": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- displayName
-
The name that will be displayed as the friendly name for the user in AWS CodeStar.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^\S(.*\S)?$
Required: Yes
- emailAddress
-
The email address that will be displayed as part of the user's profile in AWS CodeStar.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 128.
Pattern:
^[\w-.+]+@[\w-.+]+$
Required: Yes
- sshPublicKey
-
The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.
Type: String
Length Constraints: Maximum length of 16384.
Pattern:
^[\t\r\n\u0020-\u00FF]*$
Required: No
- userArn
-
The Amazon Resource Name (ARN) of the user in IAM.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 95.
Pattern:
^arn:aws:iam::\d{12}:user(?:(\u002F)|(\u002F[\u0021-\u007E]+\u002F))[\w+=,.@-]+$
Required: Yes
Response Syntax
{
"createdTimestamp": number,
"displayName": "string",
"emailAddress": "string",
"lastModifiedTimestamp": number,
"sshPublicKey": "string",
"userArn": "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.
- createdTimestamp
-
The date the user profile was created, in timestamp format.
Type: Timestamp
- displayName
-
The name that is displayed as the friendly name for the user in AWS CodeStar.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^\S(.*\S)?$
- emailAddress
-
The email address that is displayed as part of the user's profile in AWS CodeStar.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 128.
Pattern:
^[\w-.+]+@[\w-.+]+$
- lastModifiedTimestamp
-
The date the user profile was last modified, in timestamp format.
Type: Timestamp
- sshPublicKey
-
The SSH public key associated with the user in AWS CodeStar. This is the public portion of the public/private keypair the user can use to access project resources if a project owner allows the user remote access to those resources.
Type: String
Length Constraints: Maximum length of 16384.
Pattern:
^[\t\r\n\u0020-\u00FF]*$
- userArn
-
The Amazon Resource Name (ARN) of the user in IAM.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 95.
Pattern:
^arn:aws:iam::\d{12}:user(?:(\u002F)|(\u002F[\u0021-\u007E]+\u002F))[\w+=,.@-]+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- UserProfileAlreadyExistsException
-
A user profile with that name already exists in this region for the AWS account. AWS CodeStar user profile names must be unique within a region for the AWS account.
HTTP Status Code: 400
- ValidationException
-
The specified input is either not valid, or it could not be validated.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of CreateUserProfile.
Sample Request
POST / HTTP/1.1
Host: codestar.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 1019
X-Amz-Target: CodeStar_20170419.CreateUserProfile
X-Amz-Date: 20170406T004805Z
User-Agent: aws-cli/1.11.36 Python/2.7.9 Windows/7 botocore/1.4.93
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AIDACKCEVSQ6C2EXAMPLE/20170406/us-east-1/codestar/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=c25ddcd5EXAMPLE
{
"emailAddress": "jane.doe@example.com",
"sshPublicKey": "EXAMPLE=",
"displayName": "Jane Doe",
"userArn": "arn:aws:iam::111111111111:user/Jane_Doe"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: b34f8665-EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 1089
Date: Thu, 06 Apr 2017 00:48:07 GMT
{
"createdTimestamp":1.491439687681E9,"
displayName":"Jane Doe",
"emailAddress":"jane.doe@example.com",
"lastModifiedTimestamp":1.491439687681E9,
"sshPublicKey":"EXAMPLE=","userArn":"arn:aws:iam::111111111111:user/Jane_Doe"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: