neoserver 0.1.2

List claim mappings

GET /api/v1/workspaces/{workspace}/claim-mappings · Claim Mappings

← All operations and schemas

GET /api/v1/workspaces/{workspace}/claim-mappings

Returns all OIDC/JWT claim mappings for a workspace.

Operation ID: listClaimMappings

Authentication

Use one of the following authentication options. Permissions and workspace scope still apply. See authentication and access control.

Authorization: Bearer YOUR_ACCESS_TOKEN
X-API-Key: YOUR_API_KEY

Parameters

workspace path required: Workspace ID

string

Responses

200 List of claim mappings

Content type application/json

object

claim_mappings array of ClaimMapping ↗

401 Unauthorized

Content type application/json

403 Forbidden

Content type application/json

413 Request body exceeds the configured limit

Content type application/json

426 HTTPS required

Content type application/json

429 Request rate exceeded

Content type application/json

503 Service temporarily unavailable

Content type application/json

OpenAPI operation definition

{
  "description": "Returns all OIDC/JWT claim mappings for a workspace.",
  "operationId": "listClaimMappings",
  "parameters": [
    {
      "description": "Workspace ID",
      "in": "path",
      "name": "workspace",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "properties": {
              "claim_mappings": {
                "items": {
                  "$ref": "#/components/schemas/ClaimMapping"
                },
                "type": "array"
              }
            },
            "type": "object"
          }
        }
      },
      "description": "List of claim mappings"
    },
    "401": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Unauthorized"
    },
    "403": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Forbidden"
    },
    "413": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Request body exceeds the configured limit"
    },
    "426": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "HTTPS required"
    },
    "429": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Request rate exceeded"
    },
    "503": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Service temporarily unavailable"
    }
  },
  "summary": "List claim mappings",
  "tags": [
    "Claim Mappings"
  ]
}