Skip to main content

Enterprise administration

Reference documentation for GraphQL schema types in the Enterprise administration category.

In this article

Queries

enterprise

Query

Look up an enterprise by URL slug.

Type: Enterprise

Arguments for enterprise

NameDescription

invitationToken (String)

The enterprise invitation token.

slug (String!)

The enterprise URL slug.

enterpriseAdministratorInvitation

Query

Look up a pending enterprise administrator invitation by invitee, enterprise and role.

Type: EnterpriseAdministratorInvitation

Arguments for enterpriseAdministratorInvitation

NameDescription

enterpriseSlug (String!)

The slug of the enterprise the user was invited to join.

role (EnterpriseAdministratorRole!)

The role for the enterprise member invitation.

userLogin (String!)

The login of the user invited to join the enterprise.

enterpriseAdministratorInvitationByToken

Query

Look up a pending enterprise administrator invitation by invitation token. If the invitation was sent to an email address, the viewer must have verified that email address, or otherwise be an administrator of the enterprise.

Type: EnterpriseAdministratorInvitation

Arguments for enterpriseAdministratorInvitationByToken

NameDescription

invitationToken (String!)

The invitation token sent with the invitation email.

enterpriseMemberInvitation

Query

Look up a pending enterprise unaffiliated member invitation by invitee and enterprise.

Type: EnterpriseMemberInvitation

Arguments for enterpriseMemberInvitation

NameDescription

enterpriseSlug (String!)

The slug of the enterprise the user was invited to join.

userLogin (String!)

The login of the user invited to join the enterprise.

enterpriseMemberInvitationByToken

Query

Look up a pending enterprise unaffiliated member invitation by invitation token. If the invitation was sent to an email address, the viewer must have verified that email address, or otherwise be an administrator of the enterprise.

Type: EnterpriseMemberInvitation

Arguments for enterpriseMemberInvitationByToken

NameDescription

invitationToken (String!)

The invitation token sent with the invitation email.

Mutations

acceptEnterpriseAdministratorInvitation

Mutation

Accepts a pending invitation for a user to become an administrator of an enterprise.

Input fields for acceptEnterpriseAdministratorInvitation

Return fields for acceptEnterpriseAdministratorInvitation

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

invitation (EnterpriseAdministratorInvitation)

The invitation that was accepted.

message (String)

A message confirming the result of accepting an administrator invitation.

acceptEnterpriseMemberInvitation

Mutation

Accepts a pending invitation for a user to become an unaffiliated member of an enterprise.

Input fields for acceptEnterpriseMemberInvitation

Return fields for acceptEnterpriseMemberInvitation

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

invitation (EnterpriseMemberInvitation)

The invitation that was accepted.

message (String)

A message confirming the result of accepting an unaffiliated member invitation.

accessUserNamespaceRepository

Mutation

Access user namespace repository for a temporary duration.

Input fields for accessUserNamespaceRepository

Return fields for accessUserNamespaceRepository

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

expiresAt (DateTime)

The time that repository access expires at.

repository (Repository)

The repository that is temporarily accessible.

addEnterpriseOrganizationMember

Mutation

Adds enterprise members to an organization within the enterprise.

Input fields for addEnterpriseOrganizationMember

Return fields for addEnterpriseOrganizationMember

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

users ([User!])

The users who were added to the organization.

addEnterpriseSupportEntitlement

Mutation

Adds a support entitlement to an enterprise member.

Input fields for addEnterpriseSupportEntitlement

Return fields for addEnterpriseSupportEntitlement

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of adding the support entitlement.

cancelEnterpriseAdminInvitation

Mutation

Cancels a pending invitation for an administrator to join an enterprise.

Input fields for cancelEnterpriseAdminInvitation

Return fields for cancelEnterpriseAdminInvitation

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

invitation (EnterpriseAdministratorInvitation)

The invitation that was canceled.

message (String)

A message confirming the result of canceling an administrator invitation.

cancelEnterpriseMemberInvitation

Mutation

Cancels a pending invitation for an unaffiliated member to join an enterprise.

Input fields for cancelEnterpriseMemberInvitation

Return fields for cancelEnterpriseMemberInvitation

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

invitation (EnterpriseMemberInvitation)

The invitation that was canceled.

message (String)

A message confirming the result of canceling an member invitation.

createEnterpriseOrganization

Mutation

Creates an organization as part of an enterprise account. User-authenticated requests make the viewer an owner. Users listed in adminLogins are invited as owners unless owner invitations are disabled, in which case they are added directly. Installation requests also add existing enterprise members directly. Invitation failures do not roll back organization creation. A personal access token used to create an organization is implicitly permitted to update the organization it created, if the organization is part of an enterprise that has SAML enabled or uses Enterprise Managed Users. If the organization is not part of such an enterprise, and instead has SAML enabled for it individually, the token will then require SAML authorization to continue working against that organization.

Input fields for createEnterpriseOrganization

Return fields for createEnterpriseOrganization

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise that owns the created organization.

organization (Organization)

The organization that was created.

createIpAllowListEntry

Mutation

Creates a new IP allow list entry.

Input fields for createIpAllowListEntry

Return fields for createIpAllowListEntry

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

ipAllowListEntry (IpAllowListEntry)

The IP allow list entry that was created.

deleteIpAllowListEntry

Mutation

Deletes an IP allow list entry.

Input fields for deleteIpAllowListEntry

Return fields for deleteIpAllowListEntry

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

ipAllowListEntry (IpAllowListEntry)

The IP allow list entry that was deleted.

grantEnterpriseOrganizationsMigratorRole

Mutation

Grant the migrator role to a user for all organizations under an enterprise account.

Input fields for grantEnterpriseOrganizationsMigratorRole

Return fields for grantEnterpriseOrganizationsMigratorRole

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizations (OrganizationConnection)

The organizations that had the migrator role applied to for the given user.

inviteEnterpriseAdmin

Mutation

Invite someone to become an administrator of the enterprise.

Input fields for inviteEnterpriseAdmin

Return fields for inviteEnterpriseAdmin

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

invitation (EnterpriseAdministratorInvitation)

The created enterprise administrator invitation.

inviteEnterpriseMember

Mutation

Invite someone to become an unaffiliated member of the enterprise.

Input fields for inviteEnterpriseMember

Return fields for inviteEnterpriseMember

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

invitation (EnterpriseMemberInvitation)

The created enterprise member invitation.

regenerateEnterpriseIdentityProviderRecoveryCodes

Mutation

Regenerates the identity provider recovery codes for an enterprise.

Input fields for regenerateEnterpriseIdentityProviderRecoveryCodes

Return fields for regenerateEnterpriseIdentityProviderRecoveryCodes

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

identityProvider (EnterpriseIdentityProvider)

The identity provider for the enterprise.

removeEnterpriseAdmin

Mutation

Removes an administrator from the enterprise.

Input fields for removeEnterpriseAdmin

Return fields for removeEnterpriseAdmin

NameDescription

admin (User)

The user who was removed as an administrator.

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The updated enterprise.

message (String)

A message confirming the result of removing an administrator.

viewer (User)

The viewer performing the mutation.

removeEnterpriseIdentityProvider

Mutation

Removes the identity provider from an enterprise. Owners of enterprises both with and without Enterprise Managed Users may use this mutation.

Input fields for removeEnterpriseIdentityProvider

Return fields for removeEnterpriseIdentityProvider

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

identityProvider (EnterpriseIdentityProvider)

The identity provider that was removed from the enterprise.

removeEnterpriseMember

Mutation

Completely removes a user from the enterprise asynchronously.

Input fields for removeEnterpriseMember

Return fields for removeEnterpriseMember

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The updated enterprise.

user (User)

The user that was removed from the enterprise.

viewer (User)

The viewer performing the mutation.

removeEnterpriseOrganization

Mutation

Removes an organization from the enterprise.

Input fields for removeEnterpriseOrganization

Return fields for removeEnterpriseOrganization

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The updated enterprise.

organization (Organization)

The organization that was removed from the enterprise.

viewer (User)

The viewer performing the mutation.

removeEnterpriseSupportEntitlement

Mutation

Removes a support entitlement from an enterprise member.

Input fields for removeEnterpriseSupportEntitlement

Return fields for removeEnterpriseSupportEntitlement

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of removing the support entitlement.

revokeEnterpriseOrganizationsMigratorRole

Mutation

Revoke the migrator role to a user for all organizations under an enterprise account.

Input fields for revokeEnterpriseOrganizationsMigratorRole

Return fields for revokeEnterpriseOrganizationsMigratorRole

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

organizations (OrganizationConnection)

The organizations that had the migrator role revoked for the given user.

setEnterpriseIdentityProvider

Mutation

Creates or updates the identity provider for an enterprise.

Input fields for setEnterpriseIdentityProvider

Return fields for setEnterpriseIdentityProvider

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

identityProvider (EnterpriseIdentityProvider)

The identity provider for the enterprise.

transferEnterpriseOrganization

Mutation

Transfer an organization from one enterprise to another enterprise.

Input fields for transferEnterpriseOrganization

Return fields for transferEnterpriseOrganization

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

organization (Organization)

The organization for which a transfer was initiated.

updateEnterpriseAdministratorRole

Mutation

Updates the role of an enterprise administrator.

Input fields for updateEnterpriseAdministratorRole

Return fields for updateEnterpriseAdministratorRole

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of changing the administrator's role.

updateEnterpriseAllowPrivateRepositoryForkingSetting

Mutation

Sets whether private repository forks are enabled for an enterprise.

Input fields for updateEnterpriseAllowPrivateRepositoryForkingSetting

Return fields for updateEnterpriseAllowPrivateRepositoryForkingSetting

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated allow private repository forking setting.

message (String)

A message confirming the result of updating the allow private repository forking setting.

updateEnterpriseDefaultRepositoryPermissionSetting

Mutation

Sets the base repository permission for organizations in an enterprise.

Input fields for updateEnterpriseDefaultRepositoryPermissionSetting

Return fields for updateEnterpriseDefaultRepositoryPermissionSetting

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated base repository permission setting.

message (String)

A message confirming the result of updating the base repository permission setting.

updateEnterpriseDeployKeySetting

Mutation

Sets whether deploy keys are allowed to be created and used for an enterprise.

Input fields for updateEnterpriseDeployKeySetting

Return fields for updateEnterpriseDeployKeySetting

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated deploy key setting.

message (String)

A message confirming the result of updating the deploy key setting.

updateEnterpriseMembersCanChangeRepositoryVisibilitySetting

Mutation

Sets whether organization members with admin permissions on a repository can change repository visibility.

Input fields for updateEnterpriseMembersCanChangeRepositoryVisibilitySetting

Return fields for updateEnterpriseMembersCanChangeRepositoryVisibilitySetting

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can change repository visibility setting.

message (String)

A message confirming the result of updating the members can change repository visibility setting.

updateEnterpriseMembersCanCreateRepositoriesSetting

Mutation

Sets the members can create repositories setting for an enterprise.

Input fields for updateEnterpriseMembersCanCreateRepositoriesSetting

Return fields for updateEnterpriseMembersCanCreateRepositoriesSetting

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can create repositories setting.

message (String)

A message confirming the result of updating the members can create repositories setting.

updateEnterpriseMembersCanDeleteIssuesSetting

Mutation

Sets the members can delete issues setting for an enterprise.

Input fields for updateEnterpriseMembersCanDeleteIssuesSetting

Return fields for updateEnterpriseMembersCanDeleteIssuesSetting

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can delete issues setting.

message (String)

A message confirming the result of updating the members can delete issues setting.

updateEnterpriseMembersCanDeleteRepositoriesSetting

Mutation

Sets the members can delete repositories setting for an enterprise.

Input fields for updateEnterpriseMembersCanDeleteRepositoriesSetting

Return fields for updateEnterpriseMembersCanDeleteRepositoriesSetting

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can delete repositories setting.

message (String)

A message confirming the result of updating the members can delete repositories setting.

updateEnterpriseMembersCanInviteCollaboratorsSetting

Mutation

Sets whether members can invite collaborators are enabled for an enterprise.

Input fields for updateEnterpriseMembersCanInviteCollaboratorsSetting

Return fields for updateEnterpriseMembersCanInviteCollaboratorsSetting

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can invite collaborators setting.

message (String)

A message confirming the result of updating the members can invite collaborators setting.

updateEnterpriseMembersCanMakePurchasesSetting

Mutation

Sets whether or not an organization owner can make purchases.

Input fields for updateEnterpriseMembersCanMakePurchasesSetting

Return fields for updateEnterpriseMembersCanMakePurchasesSetting

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can make purchases setting.

message (String)

A message confirming the result of updating the members can make purchases setting.

updateEnterpriseMembersCanUpdateProtectedBranchesSetting

Mutation

Sets the members can update protected branches setting for an enterprise.

Input fields for updateEnterpriseMembersCanUpdateProtectedBranchesSetting

Return fields for updateEnterpriseMembersCanUpdateProtectedBranchesSetting

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can update protected branches setting.

message (String)

A message confirming the result of updating the members can update protected branches setting.

updateEnterpriseMembersCanViewDependencyInsightsSetting

Mutation

Sets the members can view dependency insights for an enterprise.

Input fields for updateEnterpriseMembersCanViewDependencyInsightsSetting

Return fields for updateEnterpriseMembersCanViewDependencyInsightsSetting

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated members can view dependency insights setting.

message (String)

A message confirming the result of updating the members can view dependency insights setting.

updateEnterpriseOrganizationProjectsSetting

Mutation

Sets whether organization projects are enabled for an enterprise.

Input fields for updateEnterpriseOrganizationProjectsSetting

Return fields for updateEnterpriseOrganizationProjectsSetting

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The enterprise with the updated organization projects setting.

message (String)

A message confirming the result of updating the organization projects setting.

updateEnterpriseOwnerOrganizationRole

Mutation

Updates the role of an enterprise owner with an organization.

Input fields for updateEnterpriseOwnerOrganizationRole

Return fields for updateEnterpriseOwnerOrganizationRole

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

message (String)

A message confirming the result of changing the owner's organization role.

updateEnterpriseProfile

Mutation

Updates an enterprise's profile.

Input fields for updateEnterpriseProfile

Return fields for updateEnterpriseProfile

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

enterprise (Enterprise)

The updated enterprise.

updateEnterpriseRepositoryProjectsSetting

Mutation

Sets whether repository projects are enabled for a enterprise.

Input fields for updateEnterpriseRepositoryProjectsSetting

Return fields for updateEnterpriseRepositoryProjectsSetting

NameDescription

clientMutationId (String)