Generate a web key pair for the instance
POST/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
- application/json
- application/grpc
- application/grpc-web+proto
Body
required
rsa
object
Possible values: [RSA_BITS_UNSPECIFIED
, RSA_BITS_2048
, RSA_BITS_3072
, RSA_BITS_4096
]
Default value: RSA_BITS_UNSPECIFIED
Possible values: [RSA_HASHER_UNSPECIFIED
, RSA_HASHER_SHA256
, RSA_HASHER_SHA384
, RSA_HASHER_SHA512
]
Default value: RSA_HASHER_UNSPECIFIED
ecdsa
object
Possible values: [ECDSA_CURVE_UNSPECIFIED
, ECDSA_CURVE_P256
, ECDSA_CURVE_P384
, ECDSA_CURVE_P512
]
Default value: ECDSA_CURVE_UNSPECIFIED
Body
required
rsa
object
Possible values: [RSA_BITS_UNSPECIFIED
, RSA_BITS_2048
, RSA_BITS_3072
, RSA_BITS_4096
]
Default value: RSA_BITS_UNSPECIFIED
Possible values: [RSA_HASHER_UNSPECIFIED
, RSA_HASHER_SHA256
, RSA_HASHER_SHA384
, RSA_HASHER_SHA512
]
Default value: RSA_HASHER_UNSPECIFIED
ecdsa
object
Possible values: [ECDSA_CURVE_UNSPECIFIED
, ECDSA_CURVE_P256
, ECDSA_CURVE_P384
, ECDSA_CURVE_P512
]
Default value: ECDSA_CURVE_UNSPECIFIED
Body
required
rsa
object
Possible values: [RSA_BITS_UNSPECIFIED
, RSA_BITS_2048
, RSA_BITS_3072
, RSA_BITS_4096
]
Default value: RSA_BITS_UNSPECIFIED
Possible values: [RSA_HASHER_UNSPECIFIED
, RSA_HASHER_SHA256
, RSA_HASHER_SHA384
, RSA_HASHER_SHA512
]
Default value: RSA_HASHER_UNSPECIFIED
ecdsa
object
Possible values: [ECDSA_CURVE_UNSPECIFIED
, ECDSA_CURVE_P256
, ECDSA_CURVE_P384
, ECDSA_CURVE_P512
]
Default value: ECDSA_CURVE_UNSPECIFIED
Responses​
- 200
- 403
- 404
- default
OK
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details
object
the timestamp of the first event applied to the object.
the timestamp of the last event applied to the object.
owner
object
the parent object representing the returned objects context.
Possible values: [OWNER_TYPE_UNSPECIFIED
, OWNER_TYPE_SYSTEM
, OWNER_TYPE_INSTANCE
, OWNER_TYPE_ORG
]
Default value: OWNER_TYPE_UNSPECIFIED
{
"details": {
"id": "69629012906488334",
"created": "2024-11-22T09:27:09.906Z",
"changed": "2024-11-22T09:27:09.906Z",
"owner": "69629023906488334"
}
}
- Schema
- Example (from schema)
Schema
details
object
the timestamp of the first event applied to the object.
the timestamp of the last event applied to the object.
owner
object
the parent object representing the returned objects context.
Possible values: [OWNER_TYPE_UNSPECIFIED
, OWNER_TYPE_SYSTEM
, OWNER_TYPE_INSTANCE
, OWNER_TYPE_ORG
]
Default value: OWNER_TYPE_UNSPECIFIED
{
"details": {
"id": "69629012906488334",
"created": "2024-11-22T09:27:09.906Z",
"changed": "2024-11-22T09:27:09.906Z",
"owner": "69629023906488334"
}
}
- Schema
- Example (from schema)
Schema
details
object
the timestamp of the first event applied to the object.
the timestamp of the last event applied to the object.
owner
object
the parent object representing the returned objects context.
Possible values: [OWNER_TYPE_UNSPECIFIED
, OWNER_TYPE_SYSTEM
, OWNER_TYPE_INSTANCE
, OWNER_TYPE_ORG
]
Default value: OWNER_TYPE_UNSPECIFIED
{
"details": {
"id": "69629012906488334",
"created": "2024-11-22T09:27:09.907Z",
"changed": "2024-11-22T09:27:09.907Z",
"owner": "69629023906488334"
}
}
Returned when the user does not have permission to access the resource.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}