Skip to main content
External OpenID providers

List external OpenID providers

GET/v4/config/ows/issuer/openid-providers

Lists the external OpenID providers of the organisation. The built-in OpenID Conformance login provider comes first when the OpenID Conformance extension is on, then the providers of the organisation, newest first. For the next page, send the nextCursor of the response as cursor.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:authorization-servers:read

Query parameters

  • limitinteger

    The most items in the page: 1 to 100, default 20. Another value gives HTTP 400.

    From 1 to 100.

    Default:20

  • cursorstring

    The nextCursor of the page before, to read the next page. Leave it out for the first page. Use it as it is: a changed cursor gives HTTP 400. Do not send it with offset (HTTP 400).

  • offsetinteger

    How many items come before the page: 0 to 10000. Use it only to jump to a page of a pager, then continue with the nextCursor of the answer. Do not send it with cursor (HTTP 400). Another value gives HTTP 400.

    From 0 to 10000.

  • includeTotalboolean

    true: the answer also has total and totalCapped, the number of items of the filtered list. Send it on the first page only, for a pager. Default false. Another value gives HTTP 400.

    Default:false

Response

application/json

One page of external OpenID providers.

  • itemsobject[]

    The providers of the page. Empty when the organisation has none.

  • nextCursorstring | null

    Send it as cursor for the next page. null on the last page.

  • totalinteger

    The number of items of the filtered list, at most 10000. Only with includeTotal=true. When the list has more items, the value is 10000 and totalCapped is true.

    From 0 to 10000.

    Example:137

  • totalCappedboolean

    true when the filtered list has more than 10000 items: total then shows 10000. Only with includeTotal=true.

    Example:false