Amazon CodeStar · Schema

CreateUserProfileRequest

CreateUserProfileRequest schema from AWS CodeStar API

Developer ToolsDevOpsProject ManagementTeam Collaboration

Properties

Name Type Description
userArn object
displayName object
emailAddress object
sshPublicKey object
View JSON Schema on GitHub

JSON Schema

codestar-create-user-profile-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codestar/refs/heads/main/json-schema/codestar-create-user-profile-request-schema.json",
  "title": "CreateUserProfileRequest",
  "description": "CreateUserProfileRequest schema from AWS CodeStar API",
  "type": "object",
  "properties": {
    "userArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the user in IAM."
        }
      ]
    },
    "displayName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserProfileDisplayName"
        },
        {
          "description": "The name that will be displayed as the friendly name for the user in AWS CodeStar. "
        }
      ]
    },
    "emailAddress": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Email"
        },
        {
          "description": "The email address that will be displayed as part of the user's profile in AWS CodeStar."
        }
      ]
    },
    "sshPublicKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SshPublicKey"
        },
        {
          "description": "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."
        }
      ]
    }
  },
  "required": [
    "userArn",
    "displayName",
    "emailAddress"
  ]
}