Update JWT Authenticator

Update JWT Authenticator

All the listed privileges are required -

Privileges	Description
GLOBAL_CONFIG_MANAGEMENT	Caller should have permission to this privilege, to perform this operation.

Request

URI

PUT

https://{api_host}//localhost/rest/config/v1/jwt-authenticators/{id}

COPY

Path Parameters

string

id

Required

id

Request Body

JWT authenticator object to be updated.

JWTAuthenticatorUpdateSpec of type(s) application/json

Required

{
    "description": "Jwt Authenticator Description",
    "issuer": "portal",
    "name": "Jwt Authenticator",
    "public_keys": [
        "{\"kid\":\"keyId\",\"kty\":\"RSA\",\"n\":\"modulus\",\"e\":\"exponent\"}"
    ],
    "url": "https://example.com/portal/.well-known/openid-configuration"
}

string

description

Optional

The description of this JWT authenticator.

string

issuer

Required

The issuer of this JWT authenticator. The configured value is matched against the "iss" claim of the JWT.

string

name

Required

The name of the JWT authenticator. It must be unique among all other JWT authenticators.

array of string

public_keys

Optional

The publicKeys as Json strings for this JWT authenticator. If "publicKeys" is blank, then "url" must not be blank.

string

url

Optional

The URL to fetch the public keys for this authenticator. If "url" is blank, then "publicKeys" must not be blank.

Authentication

This operation uses the following authentication methods.

Bearer

Responses

204

No Content

Operation doesn't return any data structure

400

Bad Request

Operation doesn't return any data structure

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

409

Conflict

Operation doesn't return any data structure

On This Page

Request

Path Parameters

204 Response Body

Errors

Config Operations

Create Federation Access Group

Create IC Domain Account

Create IM Asset

Create IM Assets

Create IM Stream

Create IM Streams

Create IM Version

Create IM Versions

Create JWT Authenticator

Create Local Access Group

Create Permissions

Delete Federation Access Group

Delete IC Domain Account

Delete IM Asset

Delete IM Stream

Delete IM Version

Delete JWT Authenticator

Delete Local Access Group

Delete Permissions

Get Connection Server

Get Environment

Get Environment V2

Get Feature Settings

Get Federation Access Group

Get Federation Access Group V2

Get General Settings

Get General Settings V2

Get IC Domain Account

Get JWT Authenticator

Get Local Access Group

Get Local Access Group V2

Get Security Settings

Get Settings V2

List Connection Servers

List Federation Access Groups

List Federation Access Groups V2

List IC Domain Accounts

List IM Streams

List IM Versions

List JWT Authenticators

List Local Access Groups

List Local Access Groups V2

List Permissions

List RCX Servers

List Selectable Privileges

List VC Info V2

Mark Datastores For Archival

Register RCX Client

Unregister RCX Client

Update Connection Server

Update Feature Settings

Update General Settings

Update General Settings V2

Update IC Domain Account

Update IM Asset

Update IM Stream

Update IM Version

Update JWT Authenticator

Update RCX Client

Update Security Settings

Update Settings

Update Settings V2