Skip to main content

List Web Keys

GET 
/v2beta/web_keys

List all web keys and their states.

Required permission:

  • iam.web_key.read

Required feature flag:

  • web_key

Responses​

List of all web keys.

Schema

    webKeys

    object[]

  • Array [

    • id string

    The unique identifier of the key.

    creationDate date-time

    The timestamp of the key creation.

    changeDate date-time

    The timestamp of the last change to the key (e.g. creation, activation, deactivation).

    state State of the key (string)

    Possible values: [STATE_UNSPECIFIED, STATE_INITIAL, STATE_ACTIVE, STATE_INACTIVE, STATE_REMOVED]

    Default value: STATE_UNSPECIFIED

    • STATE_INITIAL: A newly created key is in the initial state and published to the public key endpoint.
    • STATE_ACTIVE: The active key is used to sign tokens. Only one key can be active at a time.
    • STATE_INACTIVE: The inactive key is not used to sign tokens anymore, but still published to the public key endpoint.
    • STATE_REMOVED: The removed key is not used to sign tokens anymore and not published to the public key endpoint.

    rsa

    object

    bits - RSA_BITS_2048: 2048 bit RSA key - RSA_BITS_3072: 3072 bit RSA key - RSA_BITS_4096: 4096 bit RSA key (string)

    Possible values: [RSA_BITS_UNSPECIFIED, RSA_BITS_2048, RSA_BITS_3072, RSA_BITS_4096]

    Default value: RSA_BITS_2048

    Bit size of the RSA key. Default is 2048 bits.

    hasher - RSA_HASHER_SHA256: SHA256 hashing algorithm resulting in the RS256 algorithm header - RSA_HASHER_SHA384: SHA384 hashing algorithm resulting in the RS384 algorithm header - RSA_HASHER_SHA512: SHA512 hashing algorithm resulting in the RS512 algorithm header (string)

    Possible values: [RSA_HASHER_UNSPECIFIED, RSA_HASHER_SHA256, RSA_HASHER_SHA384, RSA_HASHER_SHA512]

    Default value: RSA_HASHER_SHA256

    Signing algrithm used. Default is SHA256.

    ecdsa

    object

    curve - ECDSA_CURVE_P256: NIST P-256 curve resulting in the ES256 algorithm header - ECDSA_CURVE_P384: NIST P-384 curve resulting in the ES384 algorithm header - ECDSA_CURVE_P512: NIST P-512 curve resulting in the ES512 algorithm header (string)

    Possible values: [ECDSA_CURVE_UNSPECIFIED, ECDSA_CURVE_P256, ECDSA_CURVE_P384, ECDSA_CURVE_P512]

    Default value: ECDSA_CURVE_P256

    Curve of the ECDSA key. Default is P-256.

    ed25519 object

  • ]

Loading...