Jump to

• Request
• Response

Update a jwkset

patch

https://{your_site_interface}/opa-hub/api/12.2.35/jwksets/{jwkset-purpose}

This operation will update a jwkset.

Request

Path Parameters

• jwkset-purpose(required): string
  The JWK set's purpose.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• activeKeyID(required): string
  The 'kid' of the active key in this set, if one has been set.

{
    "type":"object",
    "properties":{
        "activeKeyID":{
            "type":"string",
            "description":"The 'kid' of the active key in this set, if one has been set.",
            "nullable":true
        }
    },
    "additionalProperties":false,
    "required":[
        "activeKeyID"
    ]
}

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The request was successfully completed.

Body ()

Root Schema : jwkset

Type: object

Show Source

• activeKeyID: string
  The 'kid' of the active key in this set, if one has been set.
• allowedKeyUse: string
  Read Only: true

  Allowed Values: [ "enc", "sig" ]

  The 'use' value which keys in this set must have, i.e. 'enc' for encryption or 'sig' for signing.
• keys: object jwksetKeys
• purpose: string
  Read Only: true

  The JWK set's purpose.

{
    "type":"object",
    "properties":{
        "purpose":{
            "type":"string",
            "description":"The JWK set's purpose.",
            "readOnly":true
        },
        "allowedKeyUse":{
            "type":"string",
            "description":"The 'use' value which keys in this set must have, i.e. 'enc' for encryption or 'sig' for signing.",
            "readOnly":true,
            "enum":[
                "enc",
                "sig"
            ]
        },
        "activeKeyID":{
            "type":"string",
            "description":"The 'kid' of the active key in this set, if one has been set.",
            "nullable":true
        },
        "keys":{
            "readOnly":true,
            "$ref":"#/components/schemas/jwksetKeys"
        }
    },
    "additionalProperties":false
}

Nested Schema : jwksetKeys

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jwksetKey"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object jwksetKey

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jwksetKey"
    }
}

Nested Schema : jwksetKey

Type: object

Show Source

• crv: string
  Allowed Values: [ "P-256", "P-384", "P-521" ]

  The cryptographic curve name use by an elliptical curve (EC) algorithm.
• kid(required): string
  The ID of the key.
• kty: string
  Allowed Values: [ "EC" ]

  Key type parameter.
• use: string
  Allowed Values: [ "enc", "sig" ]

  Public key use, i.e. 'enc'. Must match JWK set's allowed key use.
• x: string
  The 'x' coordinate for an elliptical curve point.
• y: string
  The 'y' coordinate for an elliptical curve point.

{
    "type":"object",
    "properties":{
        "kid":{
            "type":"string",
            "description":"The ID of the key."
        },
        "kty":{
            "type":"string",
            "description":"Key type parameter.",
            "enum":[
                "EC"
            ]
        },
        "use":{
            "type":"string",
            "description":"Public key use, i.e. 'enc'. Must match JWK set's allowed key use.",
            "enum":[
                "enc",
                "sig"
            ]
        },
        "crv":{
            "type":"string",
            "description":"The cryptographic curve name use by an elliptical curve (EC) algorithm.",
            "enum":[
                "P-256",
                "P-384",
                "P-521"
            ]
        },
        "x":{
            "type":"string",
            "description":"The 'x' coordinate for an elliptical curve point."
        },
        "y":{
            "type":"string",
            "description":"The 'y' coordinate for an elliptical curve point."
        }
    },
    "additionalProperties":false,
    "required":[
        "kid"
    ]
}

Back to Top