> ## Documentation Index > Fetch the complete documentation index at: https://docs.credibledata.com/llms.txt > Use this file to discover all available pages before exploring further. # Create an organization-creation invite token > Creates a single organization-creation invite token. The token can be redeemed exactly once via `POST /organizations` with the `X-Invite-Token` header set, to create a new organization on the fly. To mint a batch (e.g. for an outreach campaign), call this endpoint once per token — the operation is independent per call so per-invite settings (`boundEmail`, `expiresAt`) can vary freely. **Authorization**: Requires the system-level `can_create_organization` permission. **Body fields:** only `boundEmail` and `expiresAt` are honored. Server defaults apply when omitted (open invite; 30-day expiry; server caps at 90 days). Tokens are short, case-insensitive signup codes (e.g. `ABCDE-FGHJK`) — they are the natural id used for all subsequent reads and revocations. ## OpenAPI ````yaml /controlplane-public-api-doc.yaml post /invites openapi: 3.1.0 info: title: Credible Admin API description: > The Credible Admin API is a comprehensive REST API that empowers organizations to manage their Malloy data modeling ecosystem with enterprise-grade security and governance. This API provides programmatic access to all administrative functions, enabling seamless integration with existing workflows and automation systems. ## Key Features - **Organization Management**: Create and manage organizations with fine-grained access controls - **Environment & Package Lifecycle**: Full CRUD operations for environments, packages, and versions - **Connection Management**: Secure database connection configuration and management - **Permission Management**: Granular role-based access control (RBAC) at organization, environment, package, workspace, and document levels - **Workspace Management**: Collaborative workspaces for data modeling and analysis - **User & Group Management**: Comprehensive user administration with group-based permissions ## Resource Hierarchy The API follows a hierarchical resource structure with fine-grained permission management at each level: ``` Organizations ├── Permissions ├── Environments │ ├── Permissions │ ├── Packages │ │ ├── Permissions │ │ └── Versions │ └── Connections ├── Workspaces │ ├── Permissions │ └── Documents │ └── Permissions └── Groups ├── Permissions └── Members System-Level Resources: ├── Users ├── System Permissions └── Demo Operations ``` ## Authentication & Authorization All API endpoints require proper authentication. The API implements fine-grained authorization using role-based permissions: - **Admin**: Full access to all resources within scope - **Modeler**: Can create and modify data models and packages - **Viewer**: Read-only access to resources - **Manager**: Workspace management capabilities - **Editor**: Document editing permissions ## Rate Limiting & Best Practices - API requests are rate-limited to ensure system stability - Implement proper error handling and retry logic - Cache responses when appropriate to reduce API calls ## Support & Documentation For additional support, examples, and integration guides, visit our developer documentation or contact our support team. version: v0 contact: name: Credible Support email: support@credibledata.com url: https://credibledata.com/support license: name: Proprietary url: https://credibledata.com/license termsOfService: https://credibledata.com/terms servers: - url: https://{organization}.admin.credibledata.com/api/v0/ description: Production API server variables: organization: default: demo description: Your organization subdomain security: - bearerAuth: [] tags: - name: organizations description: >- Organization management operations for creating, updating, and managing organizational entities - name: organizationPermissions description: >- Fine-grained permission management for organizations, including role assignments and access controls - name: environments description: >- Environment lifecycle management including creation, configuration, and deletion of data modeling environments - name: environmentPermissions description: >- Permission management for environments, controlling access to environment resources and capabilities - name: packages description: >- Package management for Malloy data models, including versioning, publishing, and distribution - name: packagePermissions description: >- Access control for packages, managing who can view, modify, or publish package versions - name: versions description: >- Version management for packages, including archiving, status updates, and lifecycle management - name: connections description: >- Database connection management for secure data source configuration and access - name: materializations description: >- Malloy Persistence materializations (per-version serving anchors for persisted sources) - name: indexes description: >- Malloy Persistence dimensional search indexes (per-version serving anchors for indexed dimensions) - name: runs description: >- Malloy Persistence build/refresh runs — one package-level build event carrying typed units (materialized sources + built indexes) - name: workspaces description: >- Collaborative workspace management for team-based data modeling and analysis - name: workspacePermissions description: >- Access control for workspaces, managing who can view, manage, or collaborate in workspaces - name: documents description: >- Document management within workspaces, including workbooks, dashboards, and other content - name: documentPermissions description: >- Access control for documents, managing who can view, edit, or share document content - name: groups description: >- User group management for organizing users and managing group-based permissions - name: users description: >- User account management including creation, updates, and profile management - name: demo description: Demo and self-service operations for quick setup and testing scenarios - name: permissions description: System-level permission management for administrative functions - name: bookmarks description: >- User bookmark management for saving references to workspaces, models, and chats - name: attributes description: Trusted user attributes for fine-grain (row/column-level) access control - name: invites description: >- Organization-creation invite tokens. A super-admin mints tokens one per call (call `POST /invites` repeatedly to populate an outreach campaign); each token can be redeemed once by an authenticated user to create a new organization on the fly. paths: /invites: post: tags: - invites summary: Create an organization-creation invite token description: > Creates a single organization-creation invite token. The token can be redeemed exactly once via `POST /organizations` with the `X-Invite-Token` header set, to create a new organization on the fly. To mint a batch (e.g. for an outreach campaign), call this endpoint once per token — the operation is independent per call so per-invite settings (`boundEmail`, `expiresAt`) can vary freely. **Authorization**: Requires the system-level `can_create_organization` permission. **Body fields:** only `boundEmail` and `expiresAt` are honored. Server defaults apply when omitted (open invite; 30-day expiry; server caps at 90 days). Tokens are short, case-insensitive signup codes (e.g. `ABCDE-FGHJK`) — they are the natural id used for all subsequent reads and revocations. operationId: createInvite requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/Invite' responses: '200': description: Invite created successfully. The response includes the raw `token`. content: application/json: schema: $ref: '#/components/schemas/Invite' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' components: schemas: Invite: type: object description: > An organization-creation invite token. Tokens are short, case-insensitive signup codes (e.g. `ABCDE-FGHJK`) — they are the natural id for the resource and are returned by all reads. properties: token: type: string readOnly: true description: | The invite token (e.g. `ABCDE-FGHJK`). Use in the redemption URL `https://{signupHost}/?token={token}` and as the path id for `GET /invites/{token}` / `DELETE /invites/{token}`. boundEmail: type: string description: > Optional. If set, restricts redemption to a caller with this email (case-insensitive). Leave unset for open invites — typical for outreach campaigns. Honored on `POST /invites`; immutable thereafter. expiresAt: type: string format: date-time description: | ISO 8601 timestamp at which the invite expires. On `POST /invites`, defaults to now + 30 days; server caps at now + 90 days. Immutable thereafter. createdBy: type: string readOnly: true description: Email of the system admin who created the invite. createdAt: type: string format: date-time readOnly: true description: ISO 8601 timestamp indicating when the invite was created. consumedAt: type: string format: date-time readOnly: true description: >- ISO 8601 timestamp indicating when the invite was redeemed (null if unconsumed). consumedBy: type: string readOnly: true description: Email of the user who redeemed the invite (null if unconsumed). consumedOrganizationName: type: string readOnly: true description: Name of the organization created on redemption (null if unconsumed). Error: type: object x-model-name: ModelError description: Standard error response format used across all API endpoints properties: code: type: string description: > Machine-readable error code that identifies the specific error condition. Clients should branch on `code`, not on the human-readable `message` — the message text is informational and may change over time. Generic codes (may appear on any endpoint): - `VALIDATION_ERROR`: Request body or path/query parameter failed validation - `AUTHENTICATION_REQUIRED`: Valid authentication is required - `INSUFFICIENT_PERMISSIONS`: User lacks required permissions - `RESOURCE_NOT_FOUND`: Requested resource does not exist - `CONFLICT`: Generic resource state conflict (used when no more specific code applies) - `RATE_LIMIT_EXCEEDED`: API rate limit exceeded - `INTERNAL_ERROR`: Unexpected server error Endpoint-specific codes used by the signup / invites flow: - `ORGANIZATION_NAME_TAKEN`: 409 on `POST /organizations` — the requested org name (URL slug) is already in use. Retry with a different name. - `ORGANIZATION_NAME_RESERVED`: 409 on `POST /organizations` — the requested org name collides with a platform subdomain (e.g. `signup`, `admin`, `data`, `login`) and cannot be claimed. Retry with a different name. - `INVITE_ALREADY_CONSUMED`: 409 on `POST /organizations` — the supplied invite token has already been redeemed into an existing organization. Retry will not help; the token is dead. - `INVITE_ALREADY_CONSUMED_REVOKE`: 409 on `DELETE /invites/{token}` — consumed invites are preserved for audit and cannot be revoked. - `INVITE_INVALID`: 400 on `POST /organizations` — the supplied invite token is malformed or unknown. - `INVITE_EXPIRED`: 400 on `POST /organizations` — the supplied invite token is past its `expiresAt`. - `INVITE_EMAIL_MISMATCH`: 403 on `POST /organizations` — the invite is bound to a different email address than the caller. message: type: string description: Human-readable error message providing details about what went wrong responses: BadRequest: description: >- The request was malformed or can not be performed given the state of the system. content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: >- Can not perform the operation due to insufficient permissions or the state of the system. content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````