Amazon Codecatalyst User Identity Structure

Information about a user whose activity is recorded in an event for a space.

Type: object Properties: 4 Required: 2

AmazonDeveloper ToolsCI/CDCollaborationDevOpsSource Control

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

Properties

userType principalId userName awsAccountId

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

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codecatalyst/refs/heads/main/json-structure/amazon-codecatalyst-user-identity-structure.json",
  "name": "UserIdentity",
  "description": "Information about a user whose activity is recorded in an event for a space.",
  "type": "object",
  "properties": {
    "userType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserType"
        },
        {
          "description": "The role assigned to the user in a Amazon CodeCatalyst space or project when the event occurred."
        }
      ]
    },
    "principalId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The ID of the Amazon CodeCatalyst service principal."
        }
      ]
    },
    "userName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The display name of the user in Amazon CodeCatalyst."
        }
      ]
    },
    "awsAccountId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The Amazon Web Services account number of the user in Amazon Web Services, if any."
        }
      ]
    }
  },
  "required": [
    "userType",
    "principalId"
  ]
}