Inputs: Teams & users

GraphQL input types for teams, users, organizations, extensions, webhooks, transformation templates, preview keys, personal access tokens, and temp file upload in the Amplience GraphQL Management API.

Teams & users

CreateTeamInput

Field	Type	Default	Description
organizationId	ID!		The ID of the organization that owns the new team
label	String!		A short human readable description of the team
isOnboarding	Boolean		Automatically add new users to this team on their first login if no specific team is assigned via an invite.

UpdateTeamInput

Field	Type	Default	Description
id	ID!		The ID of the team to update
label	String		A short human readable description of the team
isOnboarding	Boolean		Automatically add new users to this team on their first login if no specific team is assigned via an invite.

DeleteTeamInput

Field	Type	Default	Description
id	ID!		The ID of the team to delete

AddTeamMembersInput

Field	Type	Default	Description
teamId	ID!		The ID of the team to add users to
userIds	[ID!]!		A list of users to add to the team

RemoveTeamMembersInput

Field	Type	Default	Description
teamId	ID!		The ID of the team to remove users from
userIds	[ID!]!		A list of users to remove from the team

InviteUserToOrganizationInput

Field	Type	Default	Description
organizationId	ID!		The ID of the organization to invite the user to
invitee	String!		Email of the invitee
assignedOrganizationRoles	[OrganizationRolesInput!]		Organization roles to be assigned to the user
assignedCMSHubRoles	[CMSHubRolesInput!]		CMS Hub roles to be assigned to the user
assignedCMSRepositoryRoles	[CMSRepositoryRolesInput!]		CMS Repository roles to be assigned to the user
teams	[ID!]		Teams to be assigned to the user

UpdateOrganizationInvitationInput

Field	Type	Default	Description
invitationId	ID!		The ID of the organization invitation to update
assignedOrganizationRoles	[OrganizationRolesInput!]		User's organization roles
assignedCMSHubRoles	[CMSHubRolesInput!]		User's CMS Hub roles
assignedCMSRepositoryRoles	[CMSRepositoryRolesInput!]		User's CMS Repository roles
teams	[ID!]		Teams to be assigned to the user

RevokeOrganizationInvitationInput

Field	Type	Default	Description
invitationId	ID!		The ID of the invitation

RemoveUserFromOrganizationInput

Field	Type	Default	Description
organizationId	ID!		The ID of the user to assign the role to
userId	ID!		id of the user to uninvite
removeOnlySSOIdentity	Boolean		In a situation where there is a basic identity (username/password) and also a SSO identity we cannot decide which to remove.this boolean gives you the ability to target the SSO identity explicitly. Otherwise the operation fails as we cannot decide which identity to remove

AssignOrganizationRoleToUserInput

Field	Type	Default	Description
userId	ID!		The ID of the user to assign the role to
organizationId	ID!		The ID of the org for the role that is to be assigned
role	OrganizationRole!		The role to assign to this user

AssignOrganizationRoleToTeamInput

Field	Type	Default	Description
teamId	ID!		The ID of the team to assign the role to
organizationId	ID!		The ID of the org for the role that is to be assigned
role	OrganizationRole!		The role to assign to this team

AssignCMSHubRoleToTeamInput

Field	Type	Default	Description
teamId	ID!		The ID of the team to assign the role to
cmsHubId	ID!		The ID of the repository for the role that is to be assigned
role	CMSHubRole!		The role to assign to this team

AssignCMSRepositoryRoleToTeamInput

Field	Type	Default	Description
teamId	ID!		The ID of the team to assign the role to
cmsRepositoryId	ID!		The ID of the repository for the role that is to be assigned
role	CMSRepositoryRole!		The role to assign to this team

AssignHubRoleToUserInput

Field	Type	Default	Description
userId	ID!		The ID of the user to assign the role to
cmsHubId	ID!		The ID of the repository for the role that is to be assigned
role	CMSHubRole!		The role to assign to this user

AssignRepositoryRoleToUserInput

Field	Type	Default	Description
userId	ID!		The ID of the user to assign the role to
cmsRepositoryId	ID!		The ID of the repository for the role that is to be assigned
role	CMSRepositoryRole!		The role to assign to this user

OrganizationRolesInput

Field	Type	Default	Description
organizationId	ID!		ID of the Organization that these role assignments correspond to
roles	[OrganizationRole!]!		List of organization roles assigned to this user

CMSHubRolesInput

Field	Type	Default	Description
cmsHubId	ID!		ID of the Hub that these role assignments correspond to
roles	[HubRole!]!		List of repository roles assigned to this user

CMSRepositoryRolesInput

Field	Type	Default	Description
cmsRepositoryId	ID!		ID of the Repository that these role assignments correspond to
roles	[RepositoryRole!]!		List of repository roles assigned to this user

CreditTransactionReportFilterInput

Field	Type	Default	Description
day	String
format	ReportFormat
month	String
year	String!

Personal access tokens

CreatePersonalAccessTokenInput

Field	Type	Default	Description
name	String!
organizationId	ID!

UpdatePersonalAccessTokenInput

Field	Type	Default	Description
id	ID!

DeletePersonalAccessTokenInput

Field	Type	Default	Description
id	ID!

Extensions

CreateExtensionInput

Field	Type	Default	Description
label	String!
description	String!
url	String!
icon	String!
cmsHubId	ID!

UpdateExtensionInput

Field	Type	Default	Description
id	ID!
label	String
description	String
url	String
icon	String
visibility	ExtensionVisibility
quarantined	Boolean		This can only be set by Amplience to prevent an extension from executing

DeleteExtensionInput

Field	Type	Default	Description
id	ID!

CreateExtensionReleaseInput

Field	Type	Default	Description
extensionId	ID!
label	String!
releaseNotes	String
draft	Boolean	true
sourceFiles	[ExtensionReleaseSourceFileInput!]!
latest	Boolean	false

UpdateExtensionReleaseInput

Field	Type	Default	Description
id	ID!
label	String
releaseNotes	String
draft	Boolean
deprecated	Boolean
sourceFiles	[ExtensionReleaseSourceFileInput!]
latest	Boolean

DeleteExtensionReleaseInput

Field	Type	Default	Description
id	ID!

ExtensionReleaseSourceFileInput

Field	Type	Default	Description
path	String!
content	String!

ExtensionFilterInput

Field	Type	Default	Description
keyword	String
internal	Boolean

ExtensionReleaseFilterInput

Field	Type	Default	Description
draft	Boolean

CreateExtensionInstanceInput

Field	Type	Default	Description
extensionId	ID!
label	String!
description	String
cmsHubId	ID!
extensionReleaseId	ID
env	JSON!

UpdateExtensionInstanceInput

Field	Type	Default	Description
id	ID!
label	String
description	String
extensionReleaseId	ID
env	JSON

DeleteExtensionInstanceInput

Field	Type	Default	Description
id	ID!

Transformation templates

CreateTransformationTemplateInput

Field	Type	Default	Description
mediaHubId	ID!		The ID of the media hub that owns the new tranformation template
name	String!		The name of the new transformation template, used when referencing it from Dynamic Media. Transformation template names must be unique and cannot be changed
label	String!		A short human readable description of the transformation template
template	String!		The URL query parameters that this transformation template expands to, as dcoumented in the Dynamic Media API reference

UpdateTransformationTemplateInput

Field	Type	Default	Description
id	ID!		The ID of the transformation template to update
label	String!		A short human readable description of the transformation template
template	String!		The URL query parameters that this transformation template expands to, as dcoumented in the Dynamic Media API reference

PublishTransformationTemplateInput

Field	Type	Default	Description
id	ID!		The ID of the transformation template to publish

DeleteTransformationTemplateInput

Field	Type	Default	Description
id	ID!		The ID of the transformation template to delete

Webhooks

CreateWebhookListenerInput

Field	Type	Default	Description
label	String!
schema	String!
security	CreateWebhookListenerSecurityInput!
cmsHubId	ID!

UpdateWebhookListenerInput

Field	Type	Default	Description
id	ID!
security	UpdateWebhookListenerSecurityInput
label	String
schema	String

DeleteWebhookListenerInput

Field	Type	Default	Description
id	ID!

CreateWebhookListenerSecurityHMACInput

Field	Type	Default	Description
secret	String!
header	String!
algorithm	WebhookListenerSecurityHMACAlgorithm!
encoding	WebhookListenerSecurityHMACEncoding!
digestPrefix	String

CreateWebhookListenerSecurityInput

Field	Type	Default	Description
hmac	CreateWebhookListenerSecurityHMACInput
none	WebhookListenerSecurityNoneInput

UpdateWebhookListenerSecurityHMACInput

Field	Type	Default	Description
secret	String
header	String
algorithm	WebhookListenerSecurityHMACAlgorithm
encoding	WebhookListenerSecurityHMACEncoding
digestPrefix	String

UpdateWebhookListenerSecurityInput

Field	Type	Default	Description
hmac	UpdateWebhookListenerSecurityHMACInput
none	WebhookListenerSecurityNoneInput

WebhookListenerSecurityNoneInput

Field	Type	Default	Description
dangerouslyAllowUnauthenticated	Boolean!

Preview keys

CreatePreviewKeyInput

Field	Type	Default	Description
organizationId	ID!
virtualStagingEnvironmentIds	[ID]!
label	String!
expiryDate	DateTime

UpdatePreviewKeyInput

Field	Type	Default	Description
id	ID!
enabled	Boolean

DeletePreviewKeyInput

Field	Type	Default	Description
id	String!

Temp file upload

CreateTempFileMultipartUploadUrlInput

Field	Type	Default	Description
filesize	Float!