Organization OBJECT

An organization

Fields

agentTokensAgentTokenConnection

Returns agent access tokens for an Organization. By default returns all tokens, whether revoked or non-revoked.

Arguments

firstInt

lastInt

revokedBoolean

Filter tokens by whether they are revoked or not

agentsAgentConnection

Arguments

afterString

beforeString

clusterID

Filter agents by membership of a given cluster

clusterQueue[ID!]

Filter agents to those within a given cluster queue

clusteredBoolean

Pass false to exclude agents that belong to a cluster queue

Default value: true

firstInt

isRunningJobBoolean

Filter agents by whether they are running a job or not

lastInt

metaData[String!]

Filter agents to those only having the matching meta data

searchString

Search agents for the given query terms case insensitively across name and meta data

allowedApiIpAddressesString

A space-separated allowlist of IP addresses that can access the organization via the GraphQL or REST API

apiAccessTokensOrganizationAPIAccessTokenConnection!

Returns user API access tokens that can access this organization

Arguments

afterString

Returns the elements in the list that come after the specified cursor.

beforeString

Returns the elements in the list that come before the specified cursor.

firstInt

Returns the first n elements from the list.

lastInt

Returns the last n elements from the list.

auditEventsOrganizationAuditEventConnection

Arguments

actor[ID!]

Filter the events by the IDs of the actors who initiated them

actorType[AuditActorType!]

Filter the events by the type of actor who initiated them

afterString

beforeString

firstInt

lastInt

occurredAtFromDateTime

Filter events which occurred from the given date and time

occurredAtToDateTime

Filter events which occurred until the given date and time

orderOrganizationAuditEventOrders

Order the events

Default value: RECENTLY_OCCURRED

subject[ID!]

Filter the events by the IDs of the subject they relate to

subjectType[AuditSubjectType!]

Filter the events by the type of subject they relate to

subjectUUID[ID!]

Filter the events by the UUIDs of the subject they relate to

type[AuditEventType!]

Filter the events by type

bannersOrganizationBannerConnection!

Returns active banners for this organization.

Arguments

afterString

Returns the elements in the list that come after the specified cursor.

beforeString

Returns the elements in the list that come before the specified cursor.

firstInt

Returns the first n elements from the list.

lastInt

Returns the last n elements from the list.

clusterCluster

Return cluster in the Organization by UUID

Arguments

idID!

clustersClusterConnection

Returns clusters for an Organization

Arguments

afterString

Returns the elements in the list that come after the specified cursor.

beforeString

Returns the elements in the list that come before the specified cursor.

firstInt

Returns the first n elements from the list.

lastInt

Returns the last n elements from the list.

orderClusterOrder

Order the clusters

Default value: NAME

iconUrlString

The URL to an icon representing this organization

idID!

invitationsOrganizationInvitationConnection

Arguments

afterString

beforeString

firstInt

lastInt

orderOrganizationInvitationOrders

Order the invitations

Default value: RECENTLY_CREATED

state[OrganizationInvitationStates!]

isTeamsEnabledBoolean!

Whether teams is enabled for this organization

jobsJobConnection

Arguments

afterString

Returns the elements in the list that come after the specified cursor.

agentQueryRules[String!]

beforeString

Returns the elements in the list that come before the specified cursor.

clusterID

Filter jobs by membership of a given cluster

clusterQueue[ID!]

Filter jobs to those within a given cluster queue

clusteredBoolean

Pass false to exclude jobs that belong to a cluster queue

Default value: true

concurrencyJobConcurrencySearch

finishedAtDateTime

Filter jobs by the time they finished, format yyyy-mm-dd

firstInt

Returns the first n elements from the list.

lastInt

Returns the last n elements from the list.

orderJobOrder

Order the jobs

Default value: RECENTLY_CREATED

passedBoolean

Whether or not the command job passed. Passing false will return all failed jobs (including "soft failed" jobs)

priorityJobPrioritySearch

state[JobStates!]

stepJobStepSearch

Filtering jobs based on related step information

type[JobTypes!]

membersOrganizationMemberConnection

Returns users within the organization

Arguments

afterString

beforeString

emailString

The primary email of the team member

firstInt

lastInt

orderOrganizationMemberOrder

Order the members

Default value: RECENTLY_CREATED

role[OrganizationMemberRole!]

Search members by their role

searchString

Search members named like the given query case insensitively

securityOrganizationMemberSecurityInput

ssoOrganizationMemberSSOInput

teamTeamSelector

Filter the members by team

membersRequireTwoFactorAuthenticationBoolean!

Whether this organization requires 2FA to access (Please note that this is a beta feature and is not yet available to all organizations.)

nameString!

The name of the organization

permissionsOrganizationPermissions!

pipelineTemplatesPipelineTemplateConnection

Return all the pipeline templates the current user has access to for this organization

Arguments

afterString

beforeString

firstInt

lastInt

orderPipelineTemplateOrder

Order the pipeline templates

Default value: NAME

pipelinesPipelineConnection

Return all the pipelines the current user has access to for this organization

Arguments

afterString

archivedBoolean

Filter pipelines based on whether or not they've been archived. If not provided, all pipelines are returned regardless of archived state.

beforeString

clusterID

Filter pipelines by membership of a given cluster

clusteredBoolean

Pass false to exclude pipelines that belong to a cluster

Default value: true

createdAtFromDateTime

createdAtToDateTime

favoriteBoolean

Only return favorited pipelines

firstInt

lastInt

orderPipelineOrders

Order the pipelines

Default value: RECENTLY_CREATED

repositoryPipelineRepositoryInput

searchString

Search pipelines named like the given query case insensitively

tags[String!]

Filter pipelines with those that have particular tags

teamTeamSelector

Filter the pipelines by team

publicBoolean!

Whether this organization is visible to everyone, including people outside it

registriesRegistryConnection

Return all the registries the current user has access to for this organization

Arguments

afterString

beforeString

createdAtFromDateTime

createdAtToDateTime

firstInt

lastInt

orderRegistryOrders

Order the registries

Default value: RECENTLY_CREATED

searchString

Search registries named like the given query case insensitively

teamTeamSelector

Filter the registries by team

repositoryProviders[OrganizationRepositoryProvider]

Returns the repository providers for this organization

revokeInactiveTokensAfterRevokeInactiveTokenPeriod

API tokens with access to this organization will be automatically revoked after this many seconds of inactivity. A null value indicates never revoke inactive tokens.

rulesRuleConnection

Returns rules for an Organization

Arguments

action[RuleAction!]

Filter the rules by action

afterString

Returns the elements in the list that come after the specified cursor.

beforeString

Returns the elements in the list that come before the specified cursor.

firstInt

Returns the first n elements from the list.

lastInt

Returns the last n elements from the list.

orderRuleOrder

Order the rules

Default value: RECENTLY_CREATED

sourceType[RuleSourceType!]

Filter the rules by source type

targetType[RuleTargetType!]

Filter the rules by target type

slugString!

The slug used to represent the organization in URLs

ssoOrganizationSSO

The single sign-on configuration of this organization

ssoProvidersSSOProviderConnection

Single sign on providers created for an organization

Arguments

afterString

Returns the elements in the list that come after the specified cursor.

beforeString

Returns the elements in the list that come before the specified cursor.

firstInt

Returns the first n elements from the list.

lastInt

Returns the last n elements from the list.

suitesSuiteConnection

Return all the suite the current user has access to for this organization

Arguments

afterString

beforeString

createdAtFromDateTime

createdAtToDateTime

firstInt

lastInt

orderSuiteOrders

Order the suites

Default value: RECENTLY_CREATED

searchString

Search suites named like the given query case insensitively

teamTeamSelector

Filter the suites by team

teamsTeamConnection

Returns teams within the organization that the viewer can see

Arguments

afterString

beforeString

firstInt

lastInt

orderTeamOrder

Order the teams

Default value: NAME

pipelinePipelineSelector

Filter teams by pipeline

privacy[TeamPrivacy!]

Search teams by their privacy

searchString

Search teams

userUserSelector

Filter teams by user membership

usageUsageUnionConnection!

Returns the resource usage data for this organization.

Arguments

afterString

Returns the elements in the list that come after the specified cursor.

aggregatedOnFromISO8601Date

Filter aggregations performed from this date

aggregatedOnToISO8601Date

Filter aggregations performed until this date

beforeString

Returns the elements in the list that come before the specified cursor.

firstInt

Returns the first n elements from the list.

lastInt

Returns the last n elements from the list.

pipelineIds[ID!]

Filter results by the associated Pipeline ID

Default value: []

resource[ResourceUsageType!]

Filter results by resource type

Default value: [JOB_MINUTES, TEST_EXECUTIONS]

suiteIds[ID!]

Filter results by the associated Suite ID

Default value: []

uuidString!

The public UUID for this organization

Interfaces