Cockroach Labs

Cockroach Labs JWTIssuers API

Manage JWT issuer configurations for external identity provider integrations.

Documentation GitHub OpenAPI

Operations 5

GET /api/v1/jwt-issuers List JWT issuers #

POST /api/v1/jwt-issuers Add a JWT issuer #

GET /api/v1/jwt-issuers/{id} Get a JWT issuer #

PATCH /api/v1/jwt-issuers/{id} Update a JWT issuer #

DELETE /api/v1/jwt-issuers/{id} Delete a JWT issuer #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

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/cockroach-labs:cockroach-labs-jwtissuers-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: CockroachDB Cloud JWT Issuers API
  description: The CockroachDB Cloud API is a REST interface that provides programmatic access to manage the lifecycle of clusters within a CockroachDB Cloud organization.
  version: '2024-09-16'
  contact:
    name: Cockroach Labs Support
    url: https://support.cockroachlabs.com
  termsOfService: https://www.cockroachlabs.com/cloud-terms-and-conditions/
servers:
- url: https://cockroachlabs.cloud
  description: CockroachDB Cloud Production Server
security:
- bearerAuth: []
tags:
- name: JWTIssuers
  description: Manage JWT issuer configurations for external identity provider integrations.
paths:
  /api/v1/jwt-issuers:
    get:
      operationId: ListJWTIssuers
      summary: List JWT issuers
      description: Returns a list of JWT issuer configurations registered with the organization. Requires ORG_ADMIN role.
      tags:
      - JWTIssuers
      parameters:
      - $ref: '#/components/parameters/paginationPage'
      - $ref: '#/components/parameters/paginationLimit'
      - $ref: '#/components/parameters/paginationAsOfTime'
      - $ref: '#/components/parameters/paginationSortOrder'
      responses:
        '200':
          description: List of JWT issuers returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListJWTIssuersResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: AddJWTIssuer
      summary: Add a JWT issuer
      description: Registers a new JWT issuer configuration for external identity provider integration. Requires ORG_ADMIN role.
      tags:
      - JWTIssuers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddJWTIssuerRequest'
      responses:
        '200':
          description: JWT issuer added successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JWTIssuer'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/jwt-issuers/{id}:
    get:
      operationId: GetJWTIssuer
      summary: Get a JWT issuer
      description: Retrieves a specific JWT issuer configuration by ID. Requires ORG_ADMIN role.
      tags:
      - JWTIssuers
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: JWT issuer retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JWTIssuer'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: UpdateJWTIssuer
      summary: Update a JWT issuer
      description: Updates an existing JWT issuer configuration. Requires ORG_ADMIN role.
      tags:
      - JWTIssuers
      parameters:
      - $ref: '#/components/parameters/resourceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateJWTIssuerRequest'
      responses:
        '200':
          description: JWT issuer updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JWTIssuer'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: DeleteJWTIssuer
      summary: Delete a JWT issuer
      description: Removes a JWT issuer configuration by ID. Requires ORG_ADMIN role.
      tags:
      - JWTIssuers
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: JWT issuer deleted successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JWTIssuer'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    paginationPage:
      name: pagination.page
      in: query
      description: Page number for paginated results, starting from 1.
      schema:
        type: string
    resourceId:
      name: id
      in: path
      required: true
      description: Unique identifier of the resource.
      schema:
        type: string
    paginationAsOfTime:
      name: pagination.as_of_time
      in: query
      description: RFC3339 timestamp to return results as they were at a specific point in time (time-travel query).
      schema:
        type: string
        format: date-time
    paginationLimit:
      name: pagination.limit
      in: query
      description: Maximum number of results to return per page.
      schema:
        type: integer
        format: int32
        minimum: 1
        maximum: 500
    paginationSortOrder:
      name: pagination.sort_order
      in: query
      description: Sort direction for paginated results. Accepted values are ASC and DESC.
      schema:
        type: string
        enum:
        - ASC
        - DESC
  schemas:
    ListJWTIssuersResponse:
      type: object
      description: Paginated list of JWT issuers.
      properties:
        issuers:
          type: array
          description: Array of JWT issuer objects.
          items:
            $ref: '#/components/schemas/JWTIssuer'
        pagination:
          $ref: '#/components/schemas/PaginationResponse'
    AddJWTIssuerRequest:
      type: object
      description: Request body for adding a JWT issuer.
      required:
      - issuer_url
      - jwks_id
      properties:
        issuer_url:
          type: string
          description: URL of the JWT issuer.
        jwks_id:
          type: string
          description: Identifier for the JSON Web Key Set.
    UpdateJWTIssuerRequest:
      type: object
      description: Request body for updating a JWT issuer.
      properties:
        issuer_url:
          type: string
          description: Updated URL of the JWT issuer.
        jwks_id:
          type: string
          description: Updated JWKS identifier.
    Error:
      type: object
      description: Standard error response returned by the API.
      properties:
        code:
          type: integer
          description: HTTP status code of the error.
        message:
          type: string
          description: Human-readable description of the error.
        details:
          type: array
          description: Additional detail objects providing error context.
          items:
            type: object
    PaginationResponse:
      type: object
      description: Pagination metadata included in list responses.
      properties:
        next:
          type: string
          description: Token or cursor for retrieving the next page of results.
        last:
          type: string
          description: Token or cursor for the last page of results.
        time:
          type: string
          format: date-time
          description: Server time at which the paginated query was executed.
    JWTIssuer:
      type: object
      description: A JWT issuer configuration for external identity provider integration.
      properties:
        id:
          type: string
          description: Unique identifier of the JWT issuer.
        issuer_url:
          type: string
          description: URL of the JWT issuer (identity provider).
        jwks_id:
          type: string
          description: Identifier for the JSON Web Key Set.
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: The request body or parameters are invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token authentication. Generate a token in the CockroachDB Cloud Console under Organization Settings > API Access.
externalDocs:
  description: CockroachDB Cloud API Documentation
  url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api