Skip to content

Admin BFF GraphQL API ​

The Admin BFF is the GraphQL API for the admin dashboard, covering organizations, users, memberships, roles, demo sessions, and activity logs.

Endpoints ​

CapabilityURL
GraphQL endpointPOST http://127.0.0.1:4010/graphql

The /graphql endpoint accepts POST requests only. When running locally, a GraphiQL explorer is available at http://127.0.0.1:4010/graphiql.

Example Queries ​

Demo Session ​

Returns the current user's profile, capabilities, and accessible organizations based on the selected demo account.

graphql
query DemoSession($selectedUserId: ID) {
  demoSession(selectedUserId: $selectedUserId) {
    currentAccount {
      id
      displayName
      email
    }
    capabilities {
      orgManagement
      userManagement
    }
    userManagementOrganizations {
      id
      name
      kind
      status
    }
  }
}

Variables:

json
{
  "selectedUserId": "user-tenant-admin"
}

Organizations ​

List all organizations visible to the current context.

graphql
query Organizations {
  organizations {
    id
    name
    kind
    status
    referenceId
  }
}

Users ​

List users within an organization with pagination.

graphql
query OrganizationUsers($input: UserListInput!) {
  users(input: $input) {
    totalElements
    items {
      id
      displayName
      email
      status
      memberships {
        organizationId
        roles {
          id
          name
        }
      }
    }
  }
}

Variables:

json
{
  "input": {
    "organizationId": "org-demo-001",
    "pageNumber": 0,
    "pageSize": 20
  }
}

Activity Log ​

Query activity logs with filtering, sorting, and pagination.

graphql
query AdminActivityLog($input: ActivityLogListInput!) {
  activityLogs(input: $input) {
    totalElements
    items {
      id
      eventTime
      action
      result
      summary
      actor {
        id
        displayName
        email
      }
      target {
        type
        id
        name
        email
      }
    }
  }
}

Variables:

json
{
  "input": {
    "organizationId": "org-demo-001",
    "pageNumber": 0,
    "pageSize": 10
  }
}

Available Queries and Mutations ​

CategoryOperations
SessiondemoSession
Organizationsorganizations, organization
Usersusers, user
Rolesroles
Activity LogactivityLogs
MutationsactivateUser, deactivateUser, addUserToOrganizationByEmail, changeUserRoles, addMembershipRole, removeMembershipRole