Objects: Organization & users
GraphQL object types for organizations, teams, users, invitations, and personal access tokens in the Amplience GraphQL Management API.
Organizations, plans & creditsLink copied!
OrganizationLink copied!
Implements: Node
| Field | Type | Description |
|---|---|---|
id | ID! | The ID of the object |
userPermissions | [OrganizationPermission!]! | |
name | String | Organization name |
label | String | Organization label |
invitations | InvitationConnection | Args: before: String, after: String, first: Int, last: Int |
members | UserConnection | Args: before: String, after: String, first: Int, last: Int |
creditBalance | CreditBalance | |
creditTransactionReport | CreditTransactionReport | Args: input: Credit |
entitlements | [Entitlement] | |
plans | [Plan] | |
cmsHubs | [CMSHub!]! | |
personalAccessTokenRequests | [PersonalAccessTokenRequest!]! | |
teams | [Team!]! | |
virtualStagingEnvironments | VirtualStagingEnvironmentConnection! | Only VSEs that have been created with an organizationId will be listed here. This generally applies to newly created VSEs only since October 2025. Args: before: String, after: String, first: Int, last: Int |
previewKeys | PreviewKeyConnection! | Args: before: String, after: String, first: Int, last: Int |
CreditBalanceLink copied!
| Field | Type | Description |
|---|---|---|
balance | BigInteger | |
creditAllowance | BigInteger | |
organization | Organization | |
quotaPeriod | String |
CreditTransactionReportLink copied!
| Field | Type | Description |
|---|---|---|
reportURL | String |
EntitlementLink copied!
| Field | Type | Description |
|---|---|---|
organization | Organization! | |
name | String! | |
label | String! | |
type | EntitlementValueType! | |
value | EntitlementValue! |
PlanLink copied!
| Field | Type | Description |
|---|---|---|
organization | Organization! | |
name | String! | |
entitlements | [Entitlement!]! |
ProviderLink copied!
| Field | Type | Description |
|---|---|---|
label | String! | |
imageFile | String! |
Teams, users & invitationsLink copied!
TeamLink copied!
Implements: Node
| Field | Type | Description |
|---|---|---|
id | ID! | The ID of the object |
assignedOrganizationRoles | [OrganizationRolesTeamAssignment!] | Team's organization roles |
assignedCMSHubRoles | [CMSHubRolesTeamAssignment!] | Team's CMS Hub roles |
assignedCMSRepositoryRoles | [CMSRepositoryRolesTeamAssignment!] | Team's CMS Repository roles |
organization | Organization! | Organization that this team belongs to |
label | String! | Team label |
createdDate | DateTime! | Date team was created |
updatedDate | DateTime! | Date team was last updated |
createdBy | User! | The user that created the team |
updatedBy | User! | The user that last updated the team |
isOnboarding | Boolean! | Automatically add new users to this team on their first login if no specific team is assigned via an invite. |
members | TeamMembersConnection! | Args: before: String, after: String, first: Int, last: Int |
UserLink copied!
Implements: Node
| Field | Type | Description |
|---|---|---|
id | ID! | |
mediaHubs | MediaHubConnection | Args: before: String, after: String, first: Int, last: Int |
videoTranscodingProfiles | VideoTranscodingProfileConnection | |
email | String | Member's email address |
picture | String | Member's avatar |
name | String | Member's name |
loginDateTime | String | Member's last Login timestamp |
isSSO | String | Has member logged in via SSO |
orgId | String | |
organizations | OrganizationConnection! | Args: before: String, after: String, first: Int, last: Int |
personalAccessTokens | [PersonalAccessToken!]! | |
personalAccessTokenRequests | [PersonalAccessTokenRequest!]! | |
assignedOrganizationRoles | [OrganizationRolesUserAssignment!] | User's organization roles |
assignedCMSHubRoles | [CMSHubRolesUserAssignment!] | User's CMS Hub roles |
assignedCMSRepositoryRoles | [CMSRepositoryRolesUserAssignment!] | User's CMS Repository roles |
teams | [Team!]! | Args: organizationId: ID |
InvitationLink copied!
Implements: Node
| Field | Type | Description |
|---|---|---|
id | ID! | The ID of the object |
invitee | String | Users email address |
assignedOrganizationRoles | [OrganizationRoles!] | Invitation's organization roles |
assignedCMSHubRoles | [CMSHubRoles!] | Invitation's CMS Hub roles |
assignedCMSRepositoryRoles | [CMSRepositoryRoles!] | Invitation's CMS Repository roles |
teams | [Team!] | Teams to be assigned to the user |
Role assignmentsLink copied!
OrganizationRolesLink copied!
| Field | Type | Description |
|---|---|---|
organizationId | ID! | ID of the Organization that these role assignments correspond to |
roles | [OrganizationRole!]! | List of organization roles assigned to this user |
OrganizationRolesTeamAssignmentLink copied!
| Field | Type | Description |
|---|---|---|
organizationId | ID! | ID of the Organization that these role assignments correspond to |
teamId | ID! | ID of the Team that these role assignments correspond to |
lastModified | DateTime! | The Last Modified date |
roles | [OrganizationRole!]! | List of organization roles assigned to this Team |
OrganizationRolesUserAssignmentLink copied!
| Field | Type | Description |
|---|---|---|
organizationId | ID! | ID of the Organization that these role assignments correspond to |
userId | ID! | ID of the User that these role assignments correspond to |
roles | [OrganizationRole!]! | List of organization roles assigned to this user |
Personal access tokensLink copied!
PersonalAccessTokenLink copied!
Implements: Node
| Field | Type | Description |
|---|---|---|
id | ID! | |
name | String! | |
token | String! | |
createdDate | DateTime! | |
lastUsedDate | DateTime | |
user | User! | |
organization | Organization! |
PersonalAccessTokenRequestLink copied!
| Field | Type | Description |
|---|---|---|
id | ID! | |
name | String! | |
token | String! | |
createdDate | DateTime! | |
lastUsedDate | DateTime | |
requestedBy | User! | |
organization | Organization! |
UpdatePersonalAccessTokenResponseLink copied!
| Field | Type | Description |
|---|---|---|
user | String! | |
id | ID! |