Amazon CodeStar · JSON Structure

Codestar Create User Profile Request Structure

CreateUserProfileRequest schema from AWS CodeStar API

Type: object Properties: 4 Required: 3
Developer ToolsDevOpsProject ManagementTeam Collaboration

CreateUserProfileRequest is a JSON Structure definition published by Amazon CodeStar, describing 4 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

userArn displayName emailAddress sshPublicKey

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codestar/refs/heads/main/json-structure/codestar-create-user-profile-request-structure.json",
  "name": "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"
  ]
}