Amazon CodeStar · Schema

UpdateTeamMemberRequest

UpdateTeamMemberRequest schema from AWS CodeStar API

Developer ToolsDevOpsProject ManagementTeam Collaboration

Properties

Name Type Description
projectId object
userArn object
projectRole object
remoteAccessAllowed object
View JSON Schema on GitHub

JSON Schema

codestar-update-team-member-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-update-team-member-request-schema.json",
  "title": "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"
  ]
}