DocumentationAPI reference

Rust · 0.1.0

Get Identity Provider

GET /api/v1/identity-providers/{identity-provider}

IdentityProviderService · IdentityProviderService_GetIdentityProvider

Protocol-derived reference. Authorization and instance policy still apply. Schema descriptions are inherited from the MIT-licensed application contract; examples here are not executed against a live server.

Access

Requires an authenticated account. The returned OAuth configuration never includes clientSecret.

Request

GetIdentityProvider gets an identity provider.

GET/api/v1/identity-providers/{identity-provider}

Parameters

Name / locationType / requirementDescription
identity-provider
path
string
Required
The identity-provider id.

Request body

No request body is declared.

Responses

200 · OK

application/json · IdentityProvider

default · Default error response

application/json · Status

Complete operation definition

All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.

Open JSON definition
{
  "tags": [
    "IdentityProviderService"
  ],
  "description": "GetIdentityProvider gets an identity provider.",
  "operationId": "IdentityProviderService_GetIdentityProvider",
  "parameters": [
    {
      "name": "identity-provider",
      "in": "path",
      "description": "The identity-provider id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/IdentityProvider"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}