Community

A grouping of subcommunities and domains.

type Community implements Auditable, Node, Organization {
  createdBy: User
  createdOn: DateTime
  description: String
  externalMappings(
    limit: Int = 10
    offset: Int = 0
    order: [[ExternalMappingOrder]]
    where: ExternalMappingFilter
  ): [ExternalMapping!]!
  id: UUID!
  meta: Boolean!
  modifiedBy: User
  modifiedOn: DateTime
  name: String!
  parent: Community
  readPermissions(
    limit: Int = 10
    offset: Int = 0
    order: [[ReadPermissionOrder]]
    where: ReadPermissionFilter
  ): [ReadPermission!]!
  responsibilities(
    limit: Int = 10
    offset: Int = 0
    order: [[ResponsibilityOrder]]
    where: ResponsibilityFilter
  ): [Responsibility!]!
  subCommunities(
    limit: Int = 10
    offset: Int = 0
    order: [[CommunityOrder]]
    where: CommunityFilter
  ): [Community!]!
  subDomains(
    limit: Int = 10
    offset: Int = 0
    order: [[DomainOrder]]
    where: DomainFilter
  ): [Domain!]!
  subOrganizations(
    limit: Int = 10
    offset: Int = 0
    order: [[OrganizationOrder]]
    where: OrganizationFilter
  ): [Organization!]!
  system: Boolean!
}

Fields

Community.createdBy ● User object

The user who created this resource.

Community.createdOn ● DateTime scalar

The creation date of this resource.

Community.description ● String scalar

The description of this organization.

Community.externalMappings ● [ExternalMapping!]! non-null object

The list of external mappings corresponding to this community.

Community.externalMappings.limit ● Int scalar

The maximum items to return.

Community.externalMappings.offset ● Int scalar

The number of items to skip.

Community.externalMappings.order ● [[ExternalMappingOrder]] list input

Sorting parameters.

Community.externalMappings.where ● ExternalMappingFilter input

Filtering parameters.

Community.id ● UUID! non-null scalar

The universally unique identifier of this node.

Community.meta ● Boolean! non-null scalar

When true, this organization is not listed in the community or domain tree in the UI. Typically used for hidden domains such as *Issues*.

Community.modifiedBy ● User object

The user who last modified this resource.

Community.modifiedOn ● DateTime scalar

The last modified date of this resource.

Community.name ● String! non-null scalar

The name of this organization.

Community.parent ● Community object

The parent community of this organization. It is null for root communities.

Community.readPermissions ● [ReadPermission!]! non-null object

The list of all read permissions directly assigned to this organization. This list does not include inherited read permissions.

Community.readPermissions.limit ● Int scalar

The maximum items to return.

Community.readPermissions.offset ● Int scalar

The number of items to skip.

Community.readPermissions.order ● [[ReadPermissionOrder]] list input

Sorting parameters.

Community.readPermissions.where ● ReadPermissionFilter input

Filtering parameters.

Community.responsibilities ● [Responsibility!]! non-null object

The list of all responsibilities directly assigned to this organization. This list does not include inherited responsibilities.

Community.responsibilities.limit ● Int scalar

The maximum items to return.

Community.responsibilities.offset ● Int scalar

The number of items to skip.

Community.responsibilities.order ● [[ResponsibilityOrder]] list input

Sorting parameters.

Community.responsibilities.where ● ResponsibilityFilter input

Filtering parameters.

Community.subCommunities ● [Community!]! non-null object

The list of communities available under this community.

Community.subCommunities.limit ● Int scalar

The maximum items to return.

Community.subCommunities.offset ● Int scalar

The number of items to skip.

Community.subCommunities.order ● [[CommunityOrder]] list input

Sorting parameters.

Community.subCommunities.where ● CommunityFilter input

Filtering parameters.

Community.subDomains ● [Domain!]! non-null object

The list of domains available under this community.

Community.subDomains.limit ● Int scalar

The maximum items to return.

Community.subDomains.offset ● Int scalar

The number of items to skip.

Community.subDomains.order ● [[DomainOrder]] list input

Sorting parameters.

Community.subDomains.where ● DomainFilter input

Filtering parameters.

Community.subOrganizations ● [Organization!]! non-null interface

The list of organizations available under this community.

Community.subOrganizations.limit ● Int scalar

The maximum items to return.

Community.subOrganizations.offset ● Int scalar

The number of items to skip.

Community.subOrganizations.order ● [[OrganizationOrder]] list input

Sorting parameters.

Community.subOrganizations.where ● OrganizationFilter input

Filtering parameters.

Community.system ● Boolean! non-null scalar

Whether this resource is reserved by the system.

Interfaces

Auditable interface

An interface implemented by all types holding auditing information.

Node interface

A base interface implemented by all types.

Organization interface

The parent interface for both Community and Domain types.

Returned By

communities query

Member Of

Community object ● Domain object ● Organization interface ● ReadPermission object ● Responsibility object