Organization
    Cookie Security Configuration
    Organization - Declarative APIs
    Organization - Entity APIs
    Options
    CSP Directives
    JWKS
      Get all JwksgetPost JwkspostGet JwkgetPut JwkputDelete JwkdeletePatch Jwkpatch
    Notification Channels
    Identity Providers
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

JWKS (3.50)

Endpoint:/

Get all Jwks

GET
/api/v1/entities/jwks

Returns all JSON web keys - used to verify JSON web tokens (Jwts)

Get all Jwks › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • pageinteger

    Zero-based page index (0..N)

    Default: 0
  • sizeinteger

    The size of the page to be returned

    Default: 20
  • sortstring[]

    Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    page
    all
    ALL

Get all Jwks › Responses

Request successfully processed

  • dataobject[] · unique · required
  • linksobject
  • metaobject
GET /api/v1/entities/jwks

Post Jwks

POST
/api/v1/entities/jwks

Creates JSON web key - used to verify JSON web tokens (Jwts)

Post Jwks › Request Body

  • dataobject · required

    JSON:API representation of jwk entity.

Post Jwks › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of jwk entity.

  • linksobject
POST /api/v1/entities/jwks

Get Jwk

GET
/api/v1/entities/jwks/{id}

Returns JSON web key - used to verify JSON web tokens (Jwts)

Get Jwk › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Get Jwk › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Get Jwk › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of jwk entity.

  • linksobject
GET /api/v1/entities/jwks/{id}

Put Jwk

PUT
/api/v1/entities/jwks/{id}

Updates JSON web key - used to verify JSON web tokens (Jwts)

Put Jwk › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Put Jwk › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Put Jwk › Request Body

  • dataobject · required

    JSON:API representation of jwk entity.

Put Jwk › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of jwk entity.

  • linksobject
PUT /api/v1/entities/jwks/{id}

Delete Jwk

DELETE
/api/v1/entities/jwks/{id}

Deletes JSON web key - used to verify JSON web tokens (Jwts)

Delete Jwk › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Delete Jwk › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Delete Jwk › Responses

Successfully deleted

No data returned
DELETE /api/v1/entities/jwks/{id}

Patch Jwk

PATCH
/api/v1/entities/jwks/{id}

Patches JSON web key - used to verify JSON web tokens (Jwts)

Patch Jwk › path Parameters

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

Patch Jwk › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Patch Jwk › Request Body

  • dataobject · required

    JSON:API representation of patching jwk entity.

Patch Jwk › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of jwk entity.

  • linksobject
PATCH /api/v1/entities/jwks/{id}
CSP DirectivesNotification Channels