Activate Web Key

POST 
/v2beta/web_keys/:id/activate

Switch the active signing web key. The previously active key will be deactivated. Note that the JWKs OIDC endpoint returns a cacheable response. Therefore it is not advised to activate a key that has been created within the cache duration (default is 5min), as the public key may not have been propagated to caches and clients yet.

Required permission:

• iam.web_key.write

Required feature flag:

• web_key

Request

Path Parameters

id stringrequired

Responses

200

Web key activated successfully.

application/json

Schema

Schema

changeDate date-time

The timestamp of the activation of the key.

Example (from schema)

{
  "changeDate": "2025-01-23T10:34:18.051Z"
}

application/grpc

Schema

Schema

changeDate date-time

The timestamp of the activation of the key.

Example (from schema)

{
  "changeDate": "2025-01-23T10:34:18.051Z"
}

application/grpc-web+proto

Schema

Schema

changeDate date-time

The timestamp of the activation of the key.

Example (from schema)

{
  "changeDate": "2025-01-23T10:34:18.051Z"
}

400

The feature flag web_key is not enabled.

application/json

Schema

Schema

any

application/grpc

Schema

Schema

any

application/grpc-web+proto

Schema

Schema

any

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

404

The web key to active does not exist.

application/json

Schema

Schema

any

application/grpc

Schema

Schema

any

application/grpc-web+proto

Schema

Schema

any

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...