List web key details for the instance

GET 
/resources/v3alpha/web_keys

List web key details for the instance

Request

Query Parameters

instance.id string
instance.domain string

Responses

200

OK

application/json

Schema

Schema

webKeys

object[]

Array [

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

config

object

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

state string

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

Default value: STATE_UNSPECIFIED

]

Example (from schema)

{
  "webKeys": [
    {
      "details": {
        "id": "69629012906488334",
        "created": "2024-11-22T16:27:05.972Z",
        "changed": "2024-11-22T16:27:05.972Z",
        "owner": "69629023906488334"
      },
      "config": {
        "rsa": {
          "bits": "RSA_BITS_UNSPECIFIED",
          "hasher": "RSA_HASHER_UNSPECIFIED"
        },
        "ecdsa": {
          "curve": "ECDSA_CURVE_UNSPECIFIED"
        },
        "ed25519": {}
      },
      "state": "STATE_UNSPECIFIED"
    }
  ]
}

application/grpc

Schema

Schema

webKeys

object[]

Array [

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

config

object

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

state string

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

Default value: STATE_UNSPECIFIED

]

Example (from schema)

{
  "webKeys": [
    {
      "details": {
        "id": "69629012906488334",
        "created": "2024-11-22T16:27:05.974Z",
        "changed": "2024-11-22T16:27:05.974Z",
        "owner": "69629023906488334"
      },
      "config": {
        "rsa": {
          "bits": "RSA_BITS_UNSPECIFIED",
          "hasher": "RSA_HASHER_UNSPECIFIED"
        },
        "ecdsa": {
          "curve": "ECDSA_CURVE_UNSPECIFIED"
        },
        "ed25519": {}
      },
      "state": "STATE_UNSPECIFIED"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

webKeys

object[]

Array [

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

config

object

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

state string

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

Default value: STATE_UNSPECIFIED

]

Example (from schema)

{
  "webKeys": [
    {
      "details": {
        "id": "69629012906488334",
        "created": "2024-11-22T16:27:05.974Z",
        "changed": "2024-11-22T16:27:05.974Z",
        "owner": "69629023906488334"
      },
      "config": {
        "rsa": {
          "bits": "RSA_BITS_UNSPECIFIED",
          "hasher": "RSA_HASHER_UNSPECIFIED"
        },
        "ecdsa": {
          "curve": "ECDSA_CURVE_UNSPECIFIED"
        },
        "ed25519": {}
      },
      "state": "STATE_UNSPECIFIED"
    }
  ]
}

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

Returned when the resource does not exist.

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"
    }
  ]
}

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...