Mutations: Organization & users

GraphQL mutations for teams, users, organization invitations, roles, and personal access tokens in the Amplience GraphQL Management API.

Teams & users

createTeam

Create new team

createTeam(
  input: CreateTeamInput!
): Team!

Returns: Team!

Arguments:

Argument	Type	Default	Description
input	CreateTeamInput!

updateTeam

Update an existing team

updateTeam(
  input: UpdateTeamInput!
): Team!

Returns: Team!

Arguments:

Argument	Type	Default	Description
input	UpdateTeamInput!

deleteTeam

delete an existing team

deleteTeam(
  input: DeleteTeamInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	DeleteTeamInput!

addTeamMember

Add members to Team

addTeamMember(
  input: AddTeamMembersInput!
): [User!]!

Returns: [User!]!

Arguments:

Argument	Type	Default	Description
input	AddTeamMembersInput!

removeTeamMember

Remove users from team

removeTeamMember(
  input: RemoveTeamMembersInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	RemoveTeamMembersInput!

inviteUserToOrganization

Invites a user to an organization

inviteUserToOrganization(
  input: InviteUserToOrganizationInput!
): Invitation!

Returns: Invitation!

Arguments:

Argument	Type	Default	Description
input	InviteUserToOrganizationInput!

updateOrganizationInvitation

Updates an organization invitation for a user

updateOrganizationInvitation(
  input: UpdateOrganizationInvitationInput!
): Invitation!

Returns: Invitation!

Arguments:

Argument	Type	Default	Description
input	UpdateOrganizationInvitationInput!

revokeOrganizationInvitation

Revokes an organization invitation

revokeOrganizationInvitation(
  input: RevokeOrganizationInvitationInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	RevokeOrganizationInvitationInput!

removeUserFromOrganization

Removes a user from an organization

removeUserFromOrganization(
  input: RemoveUserFromOrganizationInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	RemoveUserFromOrganizationInput!

assignOrganizationRoleToUser

Assign organization role to user

assignOrganizationRoleToUser(
  input: AssignOrganizationRoleToUserInput!
): OrganizationRolesUserAssignment!

Returns: OrganizationRolesUserAssignment!

Arguments:

Argument	Type	Default	Description
input	AssignOrganizationRoleToUserInput!

assignOrganizationRoleToTeam

Assign organization role to a team

assignOrganizationRoleToTeam(
  input: AssignOrganizationRoleToTeamInput!
): OrganizationRolesTeamAssignment!

Returns: OrganizationRolesTeamAssignment!

Arguments:

Argument	Type	Default	Description
input	AssignOrganizationRoleToTeamInput!

assignCMSHubRoleToUser

Assign hub role to user

assignCMSHubRoleToUser(
  input: AssignHubRoleToUserInput!
): CMSHubRolesUserAssignment!

Returns: CMSHubRolesUserAssignment!

Arguments:

Argument	Type	Default	Description
input	AssignHubRoleToUserInput!

assignCMSHubRoleToTeam

Assign hub role to a team

assignCMSHubRoleToTeam(
  input: AssignCMSHubRoleToTeamInput!
): CMSHubRolesTeamAssignment!

Returns: CMSHubRolesTeamAssignment!

Arguments:

Argument	Type	Default	Description
input	AssignCMSHubRoleToTeamInput!

assignCMSRepositoryRoleToUser

Assign CMS repository role to user

assignCMSRepositoryRoleToUser(
  input: AssignRepositoryRoleToUserInput!
): CMSRepositoryRolesUserAssignment!

Returns: CMSRepositoryRolesUserAssignment!

Arguments:

Argument	Type	Default	Description
input	AssignRepositoryRoleToUserInput!

assignCMSRepositoryRoleToTeam

Assign repository role to team

assignCMSRepositoryRoleToTeam(
  input: AssignCMSRepositoryRoleToTeamInput!
): CMSRepositoryRolesTeamAssignment!

Returns: CMSRepositoryRolesTeamAssignment!

Arguments:

Argument	Type	Default	Description
input	AssignCMSRepositoryRoleToTeamInput!

Personal access tokens

createPersonalAccessToken

See also: Examples: creating an access token

createPersonalAccessToken(
  input: CreatePersonalAccessTokenInput!
): PersonalAccessToken!

Returns: PersonalAccessToken!

Arguments:

Argument	Type	Default	Description
input	CreatePersonalAccessTokenInput!

requestPersonalAccessToken

requestPersonalAccessToken(
  input: CreatePersonalAccessTokenInput!
): PersonalAccessTokenRequest!

Returns: PersonalAccessTokenRequest!

Arguments:

Argument	Type	Default	Description
input	CreatePersonalAccessTokenInput!

approvePersonalAccessToken

approvePersonalAccessToken(
  input: UpdatePersonalAccessTokenInput!
): UpdatePersonalAccessTokenResponse!

Returns: UpdatePersonalAccessTokenResponse!

Arguments:

Argument	Type	Default	Description
input	UpdatePersonalAccessTokenInput!

deletePersonalAccessToken

See also: Examples: deleting an access token

deletePersonalAccessToken(
  input: DeletePersonalAccessTokenInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	DeletePersonalAccessTokenInput!