Amazon CodeStar · JSON Structure

Codestar Update Team Member Request Structure

UpdateTeamMemberRequest schema from AWS CodeStar API

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

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

Properties

projectId userArn projectRole remoteAccessAllowed

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-update-team-member-request-structure.json",
  "name": "UpdateTeamMemberRequest",
  "description": "UpdateTeamMemberRequest schema from AWS CodeStar API",
  "type": "object",
  "properties": {
    "projectId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectId"
        },
        {
          "description": "The ID of the project."
        }
      ]
    },
    "userArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the user for whom you want to change team membership attributes."
        }
      ]
    },
    "projectRole": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Role"
        },
        {
          "description": "The role assigned to the user in the project. Project roles have different levels of access. For more information, see <a href=\"http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html\">Working with Teams</a> in the <i>AWS CodeStar User Guide</i>."
        }
      ]
    },
    "remoteAccessAllowed": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RemoteAccessAllowed"
        },
        {
          "description": "Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile. Even if this is set to True, the user must associate a public key with their profile before the user can access resources."
        }
      ]
    }
  },
  "required": [
    "projectId",
    "userArn"
  ]
}