find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/cloudtruth:cloudtruth-organizations-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: CloudTruth Management Organizations API
  version: v1
  description: CloudTruth centralizes your configuration parameters and secrets making them easier to manage and use as a team.
  contact:
    name: CloudTruth Support
    email: support@cloudtruth.com
tags:
- name: Organizations
paths:
  /api/v1/organizations/:
    get:
      operationId: organizations_list
      parameters:
      - in: query
        name: name
        schema:
          type: string
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - Organizations
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedOrganizationList'
          description: ''
      summary: Organizations list
      x-summary-source: derived
    post:
      operationId: organizations_create
      tags:
      - Organizations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationCreate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/OrganizationCreate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/OrganizationCreate'
        required: true
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
          description: ''
      summary: Organizations create
      x-summary-source: derived
  /api/v1/organizations/{id}/:
    get:
      operationId: organizations_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          description: A unique identifier for the organization.
        required: true
      tags:
      - Organizations
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
          description: ''
      summary: Organizations retrieve
      x-summary-source: derived
    put:
      operationId: organizations_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          description: A unique identifier for the organization.
        required: true
      tags:
      - Organizations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Organization'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Organization'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Organization'
        required: true
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
          description: ''
      summary: Organizations update
      x-summary-source: derived
    patch:
      operationId: organizations_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          description: A unique identifier for the organization.
        required: true
      tags:
      - Organizations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedOrganization'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedOrganization'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedOrganization'
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
          description: ''
      summary: Organizations partial update
      x-summary-source: derived
    delete:
      operationId: organizations_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          description: A unique identifier for the organization.
        required: true
      tags:
      - Organizations
      security:
      - JWTAuth: []
      - ApiKeyAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
      summary: Organizations destroy
      x-summary-source: derived
components:
  schemas:
    Organization:
      type: object
      properties:
        url:
          type: string
          format: uri
          readOnly: true
        id:
          type: string
          readOnly: true
          description: A unique identifier for the organization.
        name:
          type: string
          description: The organization name.
          maxLength: 256
        project_name_pattern:
          type: string
          description: A regular expression project names must match
          maxLength: 255
        maintenance:
          type: boolean
          readOnly: true
          description: If set, we are performing maintenance on this organization and have disabled making changes
        mfa_enabled:
          type: boolean
          description: Multi-factor authentication for the organization
        version:
          allOf:
          - $ref: '#/components/schemas/VersionEnum'
          readOnly: true
          description: 'The current version of this Organization


            * `1` - NEW_SECRETS

            * `2` - API_CACHING

            * `3` - EFFECTIVE_VALUE

            * `4` - MEV

            * `5` - MEV_NATS'
        notification_config: {}
        current:
          type: boolean
          description: Indicates if this Organization is the one currently targeted by the Bearer token used by the client to authorize.
          readOnly: true
        role:
          allOf:
          - $ref: '#/components/schemas/RoleA5aEnum'
          description: Your role in the organization.
          readOnly: true
        subscription_expires_at:
          type:
          - string
          - 'null'
          format: date-time
          description: If a subscription will not auto-renew, this indicates the last active date.
          readOnly: true
        subscription_features:
          type: array
          items:
            type: string
          description: A list of optional feature names the subscription enables.
          readOnly: true
        subscription_id:
          type:
          - string
          - 'null'
          description: The subscription identifier, or None if there is an error retrieving it.
          readOnly: true
        subscription_plan_id:
          type:
          - string
          - 'null'
          description: The subscription plan code, or None if there is an error retrieving it.
          readOnly: true
        subscription_plan_name:
          type:
          - string
          - 'null'
          description: The subscription plan name, or None if there is an error retrieving it.
          readOnly: true
        copilot_enabled:
          type: boolean
          readOnly: true
          description: If set, the organization has Copilot enabled.
        auth0_organization_id:
          type:
          - string
          - 'null'
          readOnly: true
          description: The Auth0 Organization ID (e.g., 'org_abc123') when SSO is enabled.
        sso_domain:
          type:
          - string
          - 'null'
          readOnly: true
          description: The verified email domain for SSO (e.g., 'acme.com').
        sso_enabled:
          type: boolean
          readOnly: true
          description: If set, this organization requires SSO authentication via Auth0 Organizations.
        sso_migration_state:
          allOf:
          - $ref: '#/components/schemas/SsoMigrationStateEnum'
          readOnly: true
          description: 'Tracks the state of SSO migration for this organization.


            * `not_started` - Not Started

            * `in_progress` - In Progress

            * `completed` - Completed'
        created_at:
          type: string
          format: date-time
          readOnly: true
        modified_at:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
      required:
      - auth0_organization_id
      - copilot_enabled
      - created_at
      - current
      - id
      - maintenance
      - modified_at
      - name
      - role
      - sso_domain
      - sso_enabled
      - sso_migration_state
      - subscription_expires_at
      - subscription_features
      - subscription_id
      - subscription_plan_id
      - subscription_plan_name
      - url
      - version
    SsoMigrationStateEnum:
      enum:
      - not_started
      - in_progress
      - completed
      type: string
      description: '* `not_started` - Not Started

        * `in_progress` - In Progress

        * `completed` - Completed'
    PatchedOrganization:
      type: object
      properties:
        url:
          type: string
          format: uri
          readOnly: true
        id:
          type: string
          readOnly: true
          description: A unique identifier for the organization.
        name:
          type: string
          description: The organization name.
          maxLength: 256
        project_name_pattern:
          type: string
          description: A regular expression project names must match
          maxLength: 255
        maintenance:
          type: boolean
          readOnly: true
          description: If set, we are performing maintenance on this organization and have disabled making changes
        mfa_enabled:
          type: boolean
          description: Multi-factor authentication for the organization
        version:
          allOf:
          - $ref: '#/components/schemas/VersionEnum'
          readOnly: true
          description: 'The current version of this Organization


            * `1` - NEW_SECRETS

            * `2` - API_CACHING

            * `3` - EFFECTIVE_VALUE

            * `4` - MEV

            * `5` - MEV_NATS'
        notification_config: {}
        current:
          type: boolean
          description: Indicates if this Organization is the one currently targeted by the Bearer token used by the client to authorize.
          readOnly: true
        role:
          allOf:
          - $ref: '#/components/schemas/RoleA5aEnum'
          description: Your role in the organization.
          readOnly: true
        subscription_expires_at:
          type:
          - string
          - 'null'
          format: date-time
          description: If a subscription will not auto-renew, this indicates the last active date.
          readOnly: true
        subscription_features:
          type: array
          items:
            type: string
          description: A list of optional feature names the subscription enables.
          readOnly: true
        subscription_id:
          type:
          - string
          - 'null'
          description: The subscription identifier, or None if there is an error retrieving it.
          readOnly: true
        subscription_plan_id:
          type:
          - string
          - 'null'
          description: The subscription plan code, or None if there is an error retrieving it.
          readOnly: true
        subscription_plan_name:
          type:
          - string
          - 'null'
          description: The subscription plan name, or None if there is an error retrieving it.
          readOnly: true
        copilot_enabled:
          type: boolean
          readOnly: true
          description: If set, the organization has Copilot enabled.
        auth0_organization_id:
          type:
          - string
          - 'null'
          readOnly: true
          description: The Auth0 Organization ID (e.g., 'org_abc123') when SSO is enabled.
        sso_domain:
          type:
          - string
          - 'null'
          readOnly: true
          description: The verified email domain for SSO (e.g., 'acme.com').
        sso_enabled:
          type: boolean
          readOnly: true
          description: If set, this organization requires SSO authentication via Auth0 Organizations.
        sso_migration_state:
          allOf:
          - $ref: '#/components/schemas/SsoMigrationStateEnum'
          readOnly: true
          description: 'Tracks the state of SSO migration for this organization.


            * `not_started` - Not Started

            * `in_progress` - In Progress

            * `completed` - Completed'
        created_at:
          type: string
          format: date-time
          readOnly: true
        modified_at:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
    VersionEnum:
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      type: integer
      description: '* `1` - NEW_SECRETS

        * `2` - API_CACHING

        * `3` - EFFECTIVE_VALUE

        * `4` - MEV

        * `5` - MEV_NATS'
    RoleA5aEnum:
      enum:
      - OWNER
      - ADMIN
      - CONTRIB
      - VIEWER
      - NO_SECRETS
      type: string
    PaginatedOrganizationList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/Organization'
    OrganizationCreate:
      type: object
      properties:
        name:
          type: string
          description: The organization name.
          maxLength: 256
        mfa_enabled:
          type: boolean
          description: Multi-factor authentication for the organization
      required:
      - name
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: Authorization
      type: apiKey
      description: "\nUse your CloudTruth API Key to authenticate to the API.  You can get\nan API Key by creating a Service Account.  During setup of the Service\nAccount you will generate a long-lived API key intended for use by automation\nand API clients.  Access through the service account will be audited separately\nfrom any other user.\n\nIf you are just trying to use the API in a normal workflow, this is likely the\nauthentication mechanism you want to use.\n\nTo use the API Key, place your API Key in the Authorization header as 'Api-Key APIKEY', where\nAPIKEY is your CloudTruth API Key.  For example:\n\n    Authorization: Api-Key fskur.ghlsiudhrg84so938r5u\n        "
    JWTAuth:
      in: header
      name: Authorization
      type: apiKey
      description: "\nUse your JWT to authenticate to the API.  This is how the CloudTruth\nWeb UI authenticates to the backend.  It requires a user to have already logged in\nand gotten a JWT from the login process.  This is usually done by an Auth0 authentication\nflow from one of the Auth0 javascript libraries.  Alternatively, you can pull the\nJWT from your browser if you have a logged in session with the CloudTruth UI.\n\nThis authentication mechanism is intended for deeper integrations into the CloudTruth\nsystem, where you want to handle the user logins directly in your application.  For\nnormal API use, you likely want the Api-Key authentication header and not this one.\n\nTo use the JWT, place your JWT in the Authorization header as 'Bearer JWT', where\nJWT is your JWT.  For example:\n\n    Authorization: Bearer eyJhbGciOiJIkuydfy.eyJzdWIiOiIxMjM....\n        "
    tokenAuth:
      type: http
      scheme: bearer
externalDocs:
  url: https://docs.cloudtruth.com/