Skip to main content

Generate a web key pair for the instance

POST 
https://$CUSTOM-DOMAIN/resources/v3alpha/web_keys

Generate a private and public key pair. The private key can be used to sign OIDC tokens after activation. The public key can be used to valite OIDC tokens.

Request​

Query Parameters

    instance.id string
    instance.domain string

Body

required

    rsa

    object

    bits bit size of the RSA key (string)

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

    Default value: RSA_BITS_UNSPECIFIED

    hasher signing algrithm used (string)

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

    Default value: RSA_HASHER_UNSPECIFIED

    ecdsa

    object

    curve string

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

    Default value: ECDSA_CURVE_UNSPECIFIED

    ed25519 object

Responses​

OK

Schema

    details

    object

    id string
    created date-time

    the timestamp of the first event applied to the object.

    changed date-time

    the timestamp of the last event applied to the object.

    owner

    object

    the parent object representing the returned objects context.

    type string

    Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

    Default value: OWNER_TYPE_UNSPECIFIED

    id string
curl -L 'https://$CUSTOM-DOMAIN/resources/v3alpha/web_keys' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "rsa": {
    "bits": "RSA_BITS_UNSPECIFIED",
    "hasher": "RSA_HASHER_UNSPECIFIED"
  },
  "ecdsa": {
    "curve": "ECDSA_CURVE_UNSPECIFIED"
  },
  "ed25519": {}
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN
Auth
Parameters
— query
— query
Body required
{
  "rsa": {
    "bits": "RSA_BITS_UNSPECIFIED",
    "hasher": "RSA_HASHER_UNSPECIFIED"
  },
  "ecdsa": {
    "curve": "ECDSA_CURVE_UNSPECIFIED"
  },
  "ed25519": {}
}
ResponseClear

Click the Send API Request button above and see the response here!