メインコンテンツまでスキップ

インベントリAPIリファレンス

注記

オブジェクトの urn 属性と階層構造上上位オブジェクトへのポインタ（ex. realm）は readOnly かつ必須ではありません。 これらの属性についてはAPIから更新のためにオブジェクトを投入する時はそれらの属性は省略できますが、読み出すと必ず入っています。

API docs by Redocly

Chip-in Inventory API (1.0.0)

Download OpenAPI specification:Download

E-mail: mitsuru@procube.jp License: Apache 2.0

これはChip-in のインベントリにアクセスするためのAPIである。 アクセス制御は別途OPAで実装される。その仕様は inventory.rego で記述されている。

realm

マイクロサービスをグループ化するための論理的な区分。'/' などパスとして使用できない文字を含むことはできない。

List realms.

Authorizations:
bearerAuth
query Parameters
object (QueryParameter)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update an existing realm.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Update an existent realm in the SPN

name
required
string^[a-z0-9][a-z0-9-]*$

レルムの名前。URN の一部として使用される。 文字列は小文字英字、数字、ハイフンのみを含むことができる。 ただし、ハイフンで始まることはできない。 名称 "master" は予約されており、使用できない。

title
required
string

レルムの日本語名称です。

description
string

レルムの説明文です。

cacert
required
string

realm 配下の SPN hub で mTLSにおけるクライアント証明書を発行したCA局の証明書(PEM形式)の文字列

signingKey
required
string >= 24 characters

realm 配下のAPI Gateway でセッショントークンの署名に使用されるパスワード。 使用できる文字は英字、数字、ハイフン、アンダースコアのみである。

sessionTimeout
integer

セッショントークンの有効期限。単位は秒で、デフォルトは 2592000 秒 (30日)。

administrators
Array of strings

レルムの管理者のユーザID。ユーザの管理はインベントリでは行わない。認証サービス内でのみ管理され、ここではそのIDのみを参照する。

expiredAt
string <date-time>

レルムの有効期限。ISO8601形式で指定する。 この日時を過ぎると、レルムの disabled フラグは true となり、関連するリソースへのアクセスが制限される。

disabled
required
boolean

レルムが無効化されているかどうかを示すフラグ。 true の場合、レルムは無効化されており、関連するリソースへのアクセスが制限される。 false の場合、レルムは有効であり、通常の操作が可能である。

Responses

Request samples

Content type
application/json
{
  • "name": "example-realm",
  • "title": "CMSシステム",
  • "description": "CMSシステムのレルムです。",
  • "cacert": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\n...\n-----END CERTIFICATE-----",
  • "signingKey": "wUAMEUxCzAJBg1m4uS38-2__",
  • "sessionTimeout": 2592000,
  • "administrators": [
    ],
  • "expiredAt": "2024-12-31T23:59:59Z",
  • "disabled": false
}

Response samples

Content type
application/json
{
  • "name": "example-realm",
  • "title": "CMSシステム",
  • "description": "CMSシステムのレルムです。",
  • "urn": "urn:chip-in:realm:example-realm",
  • "cacert": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\n...\n-----END CERTIFICATE-----",
  • "signingKey": "wUAMEUxCzAJBg1m4uS38-2__",
  • "sessionTimeout": 2592000,
  • "administrators": [
    ],
  • "expiredAt": "2024-12-31T23:59:59Z",
  • "disabled": false
}

Add a new realm.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Create a new realm

name
required
string^[a-z0-9][a-z0-9-]*$

レルムの名前。URN の一部として使用される。 文字列は小文字英字、数字、ハイフンのみを含むことができる。 ただし、ハイフンで始まることはできない。 名称 "master" は予約されており、使用できない。

title
required
string

レルムの日本語名称です。

description
string

レルムの説明文です。

cacert
required
string

realm 配下の SPN hub で mTLSにおけるクライアント証明書を発行したCA局の証明書(PEM形式)の文字列

signingKey
required
string >= 24 characters

realm 配下のAPI Gateway でセッショントークンの署名に使用されるパスワード。 使用できる文字は英字、数字、ハイフン、アンダースコアのみである。

sessionTimeout
integer

セッショントークンの有効期限。単位は秒で、デフォルトは 2592000 秒 (30日)。

administrators
Array of strings

レルムの管理者のユーザID。ユーザの管理はインベントリでは行わない。認証サービス内でのみ管理され、ここではそのIDのみを参照する。

expiredAt
string <date-time>

レルムの有効期限。ISO8601形式で指定する。 この日時を過ぎると、レルムの disabled フラグは true となり、関連するリソースへのアクセスが制限される。

disabled
required
boolean

レルムが無効化されているかどうかを示すフラグ。 true の場合、レルムは無効化されており、関連するリソースへのアクセスが制限される。 false の場合、レルムは有効であり、通常の操作が可能である。

Responses

Request samples

Content type
application/json
{
  • "name": "example-realm",
  • "title": "CMSシステム",
  • "description": "CMSシステムのレルムです。",
  • "cacert": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\n...\n-----END CERTIFICATE-----",
  • "signingKey": "wUAMEUxCzAJBg1m4uS38-2__",
  • "sessionTimeout": 2592000,
  • "administrators": [
    ],
  • "expiredAt": "2024-12-31T23:59:59Z",
  • "disabled": false
}

Response samples

Content type
application/json
{
  • "name": "example-realm",
  • "title": "CMSシステム",
  • "description": "CMSシステムのレルムです。",
  • "urn": "urn:chip-in:realm:example-realm",
  • "cacert": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\n...\n-----END CERTIFICATE-----",
  • "signingKey": "wUAMEUxCzAJBg1m4uS38-2__",
  • "sessionTimeout": 2592000,
  • "administrators": [
    ],
  • "expiredAt": "2024-12-31T23:59:59Z",
  • "disabled": false
}

Find realm by name.

Authorizations:
bearerAuth
path Parameters
realm
required
string

Name of realm to return

Responses

Response samples

Content type
application/json
{
  • "name": "example-realm",
  • "title": "CMSシステム",
  • "description": "CMSシステムのレルムです。",
  • "urn": "urn:chip-in:realm:example-realm",
  • "cacert": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\n...\n-----END CERTIFICATE-----",
  • "signingKey": "wUAMEUxCzAJBg1m4uS38-2__",
  • "sessionTimeout": 2592000,
  • "administrators": [
    ],
  • "expiredAt": "2024-12-31T23:59:59Z",
  • "disabled": false
}

Deletes a realm.

Authorizations:
bearerAuth
path Parameters
realm
required
string

Realm name to delete

Responses

Response samples

Content type
application/json
{
  • "name": "example-realm",
  • "title": "CMSシステム",
  • "description": "CMSシステムのレルムです。",
  • "urn": "urn:chip-in:realm:example-realm",
  • "cacert": "-----BEGIN CERTIFICATE-----\nMIIDXTCCAkWgAwIBAgIJAL5z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\n...\n-----END CERTIFICATE-----",
  • "signingKey": "wUAMEUxCzAJBg1m4uS38-2__",
  • "sessionTimeout": 2592000,
  • "administrators": [
    ],
  • "expiredAt": "2024-12-31T23:59:59Z",
  • "disabled": false
}

zone

API Gateway で外部に露出するDNS上のゾーン

Update an existing zone.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which zone belogs to

Request Body schema: application/json
required

Update an existent zone in the SPN

zone
required
string <hostname>

ゾーンの名前。FQDN のサフィックスとして使用される。 文字列は小文字英字、数字、ハイフン、ピリオドのみを含むことができる。

title
required
string

ゾーンの日本語名称です。

description
string

ゾーンの説明文ですです。

dnsProvider
string

ゾーンのDNSレコードを管理するためのDNSプロバイダのURN。

acmeCertificateProvider
string

ゾーンのSSL/TLS証明書を自動的に取得するためのACME証明書プロバイダのURL

Responses

Request samples

Content type
application/json
{
  • "zone": "example.com",
  • "title": "CMSシステム検証環境ゾーン",
  • "description": "CMSシステムの検証環境用のゾーンです。",
  • "dnsProvider": "urn:chip-in:service:example-realm:example-zone-route53",
  • "acmeCertificateProvider": "https://acme-v02.api.letsencrypt.org/directory"
}

Response samples

Content type
application/json
{
  • "zone": "example.com",
  • "title": "CMSシステム検証環境ゾーン",
  • "description": "CMSシステムの検証環境用のゾーンです。",
  • "realm": "string",
  • "urn": "urn:chip-in:zone:example-realm:example.com",
  • "dnsProvider": "urn:chip-in:service:example-realm:example-zone-route53",
  • "acmeCertificateProvider": "https://acme-v02.api.letsencrypt.org/directory"
}

Add a new zone to the API gateway.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which zone belogs to

Request Body schema: application/json
required

Create a new zone in the relam

zone
required
string <hostname>

ゾーンの名前。FQDN のサフィックスとして使用される。 文字列は小文字英字、数字、ハイフン、ピリオドのみを含むことができる。

title
required
string

ゾーンの日本語名称です。

description
string

ゾーンの説明文ですです。

dnsProvider
string

ゾーンのDNSレコードを管理するためのDNSプロバイダのURN。

acmeCertificateProvider
string

ゾーンのSSL/TLS証明書を自動的に取得するためのACME証明書プロバイダのURL

Responses

Request samples

Content type
application/json
{
  • "zone": "example.com",
  • "title": "CMSシステム検証環境ゾーン",
  • "description": "CMSシステムの検証環境用のゾーンです。",
  • "dnsProvider": "urn:chip-in:service:example-realm:example-zone-route53",
  • "acmeCertificateProvider": "https://acme-v02.api.letsencrypt.org/directory"
}

Response samples

Content type
application/json
{
  • "zone": "example.com",
  • "title": "CMSシステム検証環境ゾーン",
  • "description": "CMSシステムの検証環境用のゾーンです。",
  • "realm": "string",
  • "urn": "urn:chip-in:zone:example-realm:example.com",
  • "dnsProvider": "urn:chip-in:service:example-realm:example-zone-route53",
  • "acmeCertificateProvider": "https://acme-v02.api.letsencrypt.org/directory"
}

Finds Zones

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which zone belogs to

query Parameters
object (QueryParameter)

Query parameters for filtering zones

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find zone.

Returns a single zone.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which zone belogs to

zone
required
string

zone to return

Responses

Response samples

Content type
application/json
{
  • "zone": "example.com",
  • "title": "CMSシステム検証環境ゾーン",
  • "description": "CMSシステムの検証環境用のゾーンです。",
  • "realm": "string",
  • "urn": "urn:chip-in:zone:example-realm:example.com",
  • "dnsProvider": "urn:chip-in:service:example-realm:example-zone-route53",
  • "acmeCertificateProvider": "https://acme-v02.api.letsencrypt.org/directory"
}

Deletes a zone.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which zone belogs to

zone
required
string

zone to delete

Responses

Response samples

Content type
application/json
{
  • "zone": "example.com",
  • "title": "CMSシステム検証環境ゾーン",
  • "description": "CMSシステムの検証環境用のゾーンです。",
  • "realm": "string",
  • "urn": "urn:chip-in:zone:example-realm:example.com",
  • "dnsProvider": "urn:chip-in:service:example-realm:example-zone-route53",
  • "acmeCertificateProvider": "https://acme-v02.api.letsencrypt.org/directory"
}

virtual-host

ゾーンに紐づく仮想ホスト。

Update an existing virtual host.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which zone belogs to

Request Body schema: application/json
required

Update an existent virtual host in the SPN

name
required
string^([a-z0-9][a-z0-9-]*|@)$

仮想ホストの名前。指定したサブドメインの名前と結合して FQDN を得ることができる。 文字列は小文字英字、数字、ハイフンのみを含むことができる。 たとえば、 www という仮想ホスト名でサブドメインの FQDN が example.com の場合、FQDN は www.example.com となる。 特別なホスト名 "@" はサブドメインのFQDN そのものを仮想ホストの FQDN とすることを表す。

title
required
string

仮想ホストの名称。

description
string

仮想ホストの説明文。

subdomain
required
string

この仮想ホストが属するサブドメインのURN。 仮想ホストのFQDNは、仮想ホストの名前とサブドメインの名前を結合して得られる。 たとえば、 www という仮想ホスト名でサブドメインの FQDN が stg.example.com の場合、FQDN は www.stg.example.com となる。 サブドメインは自身のレルムに属するものかサブドメインの貸出先に自身のレルムが指定されているものでなくてはならない。

routingChain
required
string

この仮想ホストに紐づくルーティングチェーンのURN。 ルーティングチェーンは、リクエストの処理を行うためのルールの集合であり、リクエストを適切なマイクロサービスに転送するためのロジックを定義する。

accessLogRecorder
string

アクセスログを記録するサービスのURN。デフォルトでは標準出力に出力される。

accessLogMaxValueLength
integer
Default: 512

アクセスログの項目の値の最大長。デフォルトは 512 で、512文字を超える場合は切り捨てられる。

object

アクセスログ出力のフォーマット。1行1オブジェクトのJSON形式で出力される。 以下の属性は常に出力される。

属性名 値
timestamp ログの時刻
category "access-log" で固定
host 仮想ホストのFQDN
certificate
Array of strings
key
string

この仮想ホストのサーバ証明書の秘密鍵。PEM形式の秘密鍵を指定する。 秘密鍵は、HTTPS通信を行うために必要であり、仮想ホストが提供するサービスのセキュリティを確保する。

disabled
boolean

仮想ホストが無効化されているかどうかを示すフラグ。 true の場合、仮想ホストは無効化されており、仮想ホストは削除され、アクセスは拒否される（TLSの場合、SSL_ERROR_HANDSHAKE_FAILURE を返し、平文の場合、400 Bad Request が返す）。 false の場合、仮想ホストは有効であり、アクセスが可能である。

Responses

Request samples

Content type
application/json
{
  • "name": "www.stg",
  • "title": "CMSシステム",
  • "description": "CMSシステムのWebUI を提供する仮想ホストです。",
  • "subdomain": "urn:chip-in:subdomain:example-realm:stg",
  • "routingChain": "urn:chip-in:routing-chain:example-realm:cms-chain",
  • "accessLogRecorder": "urn:chip-in:services:example-realm:access-log-service",
  • "accessLogMaxValueLength": 512,
  • "accessLogFormat": {
    },
  • "certificate": [
    ],
  • "key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA7v1z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYT\n...\n-----END RSA PRIVATE KEY-----",
  • "disabled": false
}

Response samples

Content type
application/json
{
  • "name": "www.stg",
  • "title": "CMSシステム",
  • "description": "CMSシステムのWebUI を提供する仮想ホストです。",
  • "realm": "urn:chip-in:realm:example-realm",
  • "urn": "urn:chip-in:virtual-host:example-realm:www",
  • "subdomain": "urn:chip-in:subdomain:example-realm:stg",
  • "routingChain": "urn:chip-in:routing-chain:example-realm:cms-chain",
  • "accessLogRecorder": "urn:chip-in:services:example-realm:access-log-service",
  • "accessLogMaxValueLength": 512,
  • "accessLogFormat": {
    },
  • "certificate": [
    ],
  • "key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA7v1z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYT\n...\n-----END RSA PRIVATE KEY-----",
  • "disabled": false
}

Add a new virtual host to the zone.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which zone belogs to

Request Body schema: application/json
required

Create a new virtual host in the zone

name
required
string^([a-z0-9][a-z0-9-]*|@)$

仮想ホストの名前。指定したサブドメインの名前と結合して FQDN を得ることができる。 文字列は小文字英字、数字、ハイフンのみを含むことができる。 たとえば、 www という仮想ホスト名でサブドメインの FQDN が example.com の場合、FQDN は www.example.com となる。 特別なホスト名 "@" はサブドメインのFQDN そのものを仮想ホストの FQDN とすることを表す。

title
required
string

仮想ホストの名称。

description
string

仮想ホストの説明文。

subdomain
required
string

この仮想ホストが属するサブドメインのURN。 仮想ホストのFQDNは、仮想ホストの名前とサブドメインの名前を結合して得られる。 たとえば、 www という仮想ホスト名でサブドメインの FQDN が stg.example.com の場合、FQDN は www.stg.example.com となる。 サブドメインは自身のレルムに属するものかサブドメインの貸出先に自身のレルムが指定されているものでなくてはならない。

routingChain
required
string

この仮想ホストに紐づくルーティングチェーンのURN。 ルーティングチェーンは、リクエストの処理を行うためのルールの集合であり、リクエストを適切なマイクロサービスに転送するためのロジックを定義する。

accessLogRecorder
string

アクセスログを記録するサービスのURN。デフォルトでは標準出力に出力される。

accessLogMaxValueLength
integer
Default: 512

アクセスログの項目の値の最大長。デフォルトは 512 で、512文字を超える場合は切り捨てられる。

object

アクセスログ出力のフォーマット。1行1オブジェクトのJSON形式で出力される。 以下の属性は常に出力される。

属性名 値
timestamp ログの時刻
category "access-log" で固定
host 仮想ホストのFQDN
certificate
Array of strings
key
string

この仮想ホストのサーバ証明書の秘密鍵。PEM形式の秘密鍵を指定する。 秘密鍵は、HTTPS通信を行うために必要であり、仮想ホストが提供するサービスのセキュリティを確保する。

disabled
boolean

仮想ホストが無効化されているかどうかを示すフラグ。 true の場合、仮想ホストは無効化されており、仮想ホストは削除され、アクセスは拒否される（TLSの場合、SSL_ERROR_HANDSHAKE_FAILURE を返し、平文の場合、400 Bad Request が返す）。 false の場合、仮想ホストは有効であり、アクセスが可能である。

Responses

Request samples

Content type
application/json
{
  • "name": "www.stg",
  • "title": "CMSシステム",
  • "description": "CMSシステムのWebUI を提供する仮想ホストです。",
  • "subdomain": "urn:chip-in:subdomain:example-realm:stg",
  • "routingChain": "urn:chip-in:routing-chain:example-realm:cms-chain",
  • "accessLogRecorder": "urn:chip-in:services:example-realm:access-log-service",
  • "accessLogMaxValueLength": 512,
  • "accessLogFormat": {
    },
  • "certificate": [
    ],
  • "key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA7v1z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYT\n...\n-----END RSA PRIVATE KEY-----",
  • "disabled": false
}

Response samples

Content type
application/json
{
  • "name": "www.stg",
  • "title": "CMSシステム",
  • "description": "CMSシステムのWebUI を提供する仮想ホストです。",
  • "realm": "urn:chip-in:realm:example-realm",
  • "urn": "urn:chip-in:virtual-host:example-realm:www",
  • "subdomain": "urn:chip-in:subdomain:example-realm:stg",
  • "routingChain": "urn:chip-in:routing-chain:example-realm:cms-chain",
  • "accessLogRecorder": "urn:chip-in:services:example-realm:access-log-service",
  • "accessLogMaxValueLength": 512,
  • "accessLogFormat": {
    },
  • "certificate": [
    ],
  • "key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA7v1z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYT\n...\n-----END RSA PRIVATE KEY-----",
  • "disabled": false
}

Finds Virtual Hosts

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which zone belogs to

query Parameters
object (QueryParameter)

Query parameters for filtering virtual hosts

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find virtual host by name.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which zone belogs to

virtualHost
required
string

Name of virtual host to return

Responses

Response samples

Content type
application/json
{
  • "name": "www.stg",
  • "title": "CMSシステム",
  • "description": "CMSシステムのWebUI を提供する仮想ホストです。",
  • "realm": "urn:chip-in:realm:example-realm",
  • "urn": "urn:chip-in:virtual-host:example-realm:www",
  • "subdomain": "urn:chip-in:subdomain:example-realm:stg",
  • "routingChain": "urn:chip-in:routing-chain:example-realm:cms-chain",
  • "accessLogRecorder": "urn:chip-in:services:example-realm:access-log-service",
  • "accessLogMaxValueLength": 512,
  • "accessLogFormat": {
    },
  • "certificate": [
    ],
  • "key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA7v1z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYT\n...\n-----END RSA PRIVATE KEY-----",
  • "disabled": false
}

Deletes a virtual host.

Delete a virtual host.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which zone belogs to

virtualHost
required
string

Virtual Host URN to delete

Responses

Response samples

Content type
application/json
{
  • "name": "www.stg",
  • "title": "CMSシステム",
  • "description": "CMSシステムのWebUI を提供する仮想ホストです。",
  • "realm": "urn:chip-in:realm:example-realm",
  • "urn": "urn:chip-in:virtual-host:example-realm:www",
  • "subdomain": "urn:chip-in:subdomain:example-realm:stg",
  • "routingChain": "urn:chip-in:routing-chain:example-realm:cms-chain",
  • "accessLogRecorder": "urn:chip-in:services:example-realm:access-log-service",
  • "accessLogMaxValueLength": 512,
  • "accessLogFormat": {
    },
  • "certificate": [
    ],
  • "key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEA7v1z1Z2k5b4wMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYT\n...\n-----END RSA PRIVATE KEY-----",
  • "disabled": false
}

routing-chain

API Gateway でのルーティングチェーン。

Update an existing routing chain.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which routing chain belogs to

Request Body schema: application/json
required

Update an existent routing chain in the Realm.

name
required
string

ルーティングチェーンの名前。URN の一部として使用される。 文字列は小文字英字、数字、ハイフン、アンダースコアのみを含むことができる。

title
required
string

ルーティングチェーンの日本語名称です。

description
string

ルーティングチェーンの説明文です。

Array of objects

ルーティングチェーンのルールのリスト。各ルールは、リクエストを処理するための条件とアクションを定義する。 ルールは、リクエストのパスやヘッダなどを照合し、適切なアクションを実行するために使用される。

Responses

Request samples

Content type
application/json
{
  • "name": "cms-chain",
  • "title": "CMSシステムルーティングチェーン",
  • "description": "CMSシステムのWebUI を提供するルーティングチェーンです。",
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "cms-chain",
  • "realm": "urn:chip-in:realm:example-realm",
  • "urn": "urn:chip-in:routing-chain:example-realm:cms-chain",
  • "title": "CMSシステムルーティングチェーン",
  • "description": "CMSシステムのWebUI を提供するルーティングチェーンです。",
  • "rules": [
    ]
}

Add a new routing chain to the Realm.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which routing chain belogs to

Request Body schema: application/json
required

Create a new routing chain in the realm.

name
required
string

ルーティングチェーンの名前。URN の一部として使用される。 文字列は小文字英字、数字、ハイフン、アンダースコアのみを含むことができる。

title
required
string

ルーティングチェーンの日本語名称です。

description
string

ルーティングチェーンの説明文です。

Array of objects

ルーティングチェーンのルールのリスト。各ルールは、リクエストを処理するための条件とアクションを定義する。 ルールは、リクエストのパスやヘッダなどを照合し、適切なアクションを実行するために使用される。

Responses

Request samples

Content type
application/json
{
  • "name": "cms-chain",
  • "title": "CMSシステムルーティングチェーン",
  • "description": "CMSシステムのWebUI を提供するルーティングチェーンです。",
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "cms-chain",
  • "realm": "urn:chip-in:realm:example-realm",
  • "urn": "urn:chip-in:routing-chain:example-realm:cms-chain",
  • "title": "CMSシステムルーティングチェーン",
  • "description": "CMSシステムのWebUI を提供するルーティングチェーンです。",
  • "rules": [
    ]
}

Finds Routing Chains

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which routing chain belogs to

query Parameters
object (QueryParameter)

Query parameters for filtering routing chains

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find routing chain by name.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which routing chain belogs to

routingChainName
required
string

Name of routing chain to return

Responses

Response samples

Content type
application/json
{
  • "name": "cms-chain",
  • "realm": "urn:chip-in:realm:example-realm",
  • "urn": "urn:chip-in:routing-chain:example-realm:cms-chain",
  • "title": "CMSシステムルーティングチェーン",
  • "description": "CMSシステムのWebUI を提供するルーティングチェーンです。",
  • "rules": [
    ]
}

Deletes a routing chain.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which routing chain belogs to

routingChainName
required
string

Routing Chain URN to delete

Responses

Response samples

Content type
application/json
{
  • "name": "cms-chain",
  • "realm": "urn:chip-in:realm:example-realm",
  • "urn": "urn:chip-in:routing-chain:example-realm:cms-chain",
  • "title": "CMSシステムルーティングチェーン",
  • "description": "CMSシステムのWebUI を提供するルーティングチェーンです。",
  • "rules": [
    ]
}

hub

SPNのハブ。

Update an existing hub.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which hub belogs to

Request Body schema: application/json
required

Update an existent hub in the SPN

name
required
string

SPN Hub の名前。URN の一部として使用される。 文字列は小文字英字、数字、ハイフン、アンダースコアのみを含むことができる。

title
required
string

SPN Hub の日本語名称です。

description
string

SPN Hub の説明文です。

fqdn
required
string

SPN Hub のサーバのFQDN

serverPort
integer

SPN Hub のサーバのポート番号。デフォルトは 443

serverCert
required
string

mTLSにおけるサーバ証明書(PEM形式)の文字列。 SPN Hub のサーバは、この証明書を使用してクライアントとの通信を暗号化する。

serverCertKey
required
string

mTLSにおけるサーバ証明書の秘密鍵(PEM形式)の文字列。 SPN Hub のサーバは、この秘密鍵を使用してクライアントとの通信を暗号化する。

Responses

Request samples

Content type
application/json
{
  • "name": "hub1",
  • "title": "CMSシステムプライベートネットワークハブ",
  • "description": "CMSシステム用のプライベートネットワークのハブ",
  • "fqdn": "core.stg.chip-in.net",
  • "serverPort": 443,
  • "serverCert": "-----BEGIN CERTIFICATE-----\n-----END CERTIFICATE-----",
  • "serverCertKey": "-----BEGIN RSA PRIVATE KEY-----\n-----END RSA PRIVATE KEY-----"
}

Response samples

Content type
application/json
{
  • "name": "hub1",
  • "realm": "urn:chip-in:realm:example-realm",
  • "urn": "urn:chip-in:network:example-realm:hub1",
  • "title": "CMSシステムプライベートネットワークハブ",
  • "description": "CMSシステム用のプライベートネットワークのハブ",
  • "fqdn": "core.stg.chip-in.net",
  • "serverPort": 443,
  • "serverCert": "-----BEGIN CERTIFICATE-----\n-----END CERTIFICATE-----",
  • "serverCertKey": "-----BEGIN RSA PRIVATE KEY-----\n-----END RSA PRIVATE KEY-----"
}

Add a new hub to the SPN.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which hub belogs to

Request Body schema: application/json
required

Create a new hub in the realm

name
required
string

SPN Hub の名前。URN の一部として使用される。 文字列は小文字英字、数字、ハイフン、アンダースコアのみを含むことができる。

title
required
string

SPN Hub の日本語名称です。

description
string

SPN Hub の説明文です。

fqdn
required
string

SPN Hub のサーバのFQDN

serverPort
integer

SPN Hub のサーバのポート番号。デフォルトは 443

serverCert
required
string

mTLSにおけるサーバ証明書(PEM形式)の文字列。 SPN Hub のサーバは、この証明書を使用してクライアントとの通信を暗号化する。

serverCertKey
required
string

mTLSにおけるサーバ証明書の秘密鍵(PEM形式)の文字列。 SPN Hub のサーバは、この秘密鍵を使用してクライアントとの通信を暗号化する。

Responses

Request samples

Content type
application/json
{
  • "name": "hub1",
  • "title": "CMSシステムプライベートネットワークハブ",
  • "description": "CMSシステム用のプライベートネットワークのハブ",
  • "fqdn": "core.stg.chip-in.net",
  • "serverPort": 443,
  • "serverCert": "-----BEGIN CERTIFICATE-----\n-----END CERTIFICATE-----",
  • "serverCertKey": "-----BEGIN RSA PRIVATE KEY-----\n-----END RSA PRIVATE KEY-----"
}

Response samples

Content type
application/json
{
  • "name": "hub1",
  • "realm": "urn:chip-in:realm:example-realm",
  • "urn": "urn:chip-in:network:example-realm:hub1",
  • "title": "CMSシステムプライベートネットワークハブ",
  • "description": "CMSシステム用のプライベートネットワークのハブ",
  • "fqdn": "core.stg.chip-in.net",
  • "serverPort": 443,
  • "serverCert": "-----BEGIN CERTIFICATE-----\n-----END CERTIFICATE-----",
  • "serverCertKey": "-----BEGIN RSA PRIVATE KEY-----\n-----END RSA PRIVATE KEY-----"
}

Finds Hubs

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which hub belogs to

query Parameters
object (QueryParameter)

Query parameters for filtering hubs

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find hub by name.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which service belogs to

hubName
required
string

Name of hub to return

Responses

Response samples

Content type
application/json
{
  • "name": "hub1",
  • "realm": "urn:chip-in:realm:example-realm",
  • "urn": "urn:chip-in:network:example-realm:hub1",
  • "title": "CMSシステムプライベートネットワークハブ",
  • "description": "CMSシステム用のプライベートネットワークのハブ",
  • "fqdn": "core.stg.chip-in.net",
  • "serverPort": 443,
  • "serverCert": "-----BEGIN CERTIFICATE-----\n-----END CERTIFICATE-----",
  • "serverCertKey": "-----BEGIN RSA PRIVATE KEY-----\n-----END RSA PRIVATE KEY-----"
}

Deletes a hub.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which hub belogs to

hubName
required
string

Hub name to delete

Responses

Response samples

Content type
application/json
{
  • "name": "hub1",
  • "realm": "urn:chip-in:realm:example-realm",
  • "urn": "urn:chip-in:network:example-realm:hub1",
  • "title": "CMSシステムプライベートネットワークハブ",
  • "description": "CMSシステム用のプライベートネットワークのハブ",
  • "fqdn": "core.stg.chip-in.net",
  • "serverPort": 443,
  • "serverCert": "-----BEGIN CERTIFICATE-----\n-----END CERTIFICATE-----",
  • "serverCertKey": "-----BEGIN RSA PRIVATE KEY-----\n-----END RSA PRIVATE KEY-----"
}

service

SPN経由で提供されるマイクロサービス

Update an existing service.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which service belogs to

hubName
required
string

Name of hub which service belogs to

Request Body schema: application/json
required

Update an existent service in the SPN

name
required
string

サービスの名前。URN の一部として使用される。 ただし、先頭がハイフンであってはならない。

title
required
string

サービスの日本語名称です。URN の一部として使用される。 文字列は日本語を含むことができる。

description
string

サービスの説明文です。URN の一部として使用される。 文字列は日本語を含むことができる。

realm
required
string

サービスが属するレルムの名前。

object

コンテナクラスタ内でマイクロサービスのスケジュール起動、オンデマンド起動を行うためのパラメータ

singleton
boolean
provider
required
string
consumers
required
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "name": "authz-rbac",
  • "title": "CMSシステム認可サービス",
  • "description": "CMSシステムの認可サービスです。",
  • "realm": "string",
  • "availabilityManagement": {
    },
  • "singleton": true,
  • "provider": "oidc-authz-provider",
  • "consumers": [ ]
}

Response samples

Content type
application/json
{
  • "name": "authz-rbac",
  • "hub": "urn:chip-in:network:example-realm:hub1",
  • "urn": "urn:chip-in:service:example-realm:hub1:authz-rbac",
  • "title": "CMSシステム認可サービス",
  • "description": "CMSシステムの認可サービスです。",
  • "realm": "string",
  • "availabilityManagement": {
    },
  • "singleton": true,
  • "provider": "oidc-authz-provider",
  • "consumers": [ ]
}

Add a new service to the SPN.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which service belogs to

hubName
required
string

Name of hub which service belogs to

Request Body schema: application/json
required

Create a new service in the realm

name
required
string

サービスの名前。URN の一部として使用される。 ただし、先頭がハイフンであってはならない。

title
required
string

サービスの日本語名称です。URN の一部として使用される。 文字列は日本語を含むことができる。

description
string

サービスの説明文です。URN の一部として使用される。 文字列は日本語を含むことができる。

realm
required
string

サービスが属するレルムの名前。

object

コンテナクラスタ内でマイクロサービスのスケジュール起動、オンデマンド起動を行うためのパラメータ

singleton
boolean
provider
required
string
consumers
required
Array of arrays

Responses

Request samples

Content type
application/json
{
  • "name": "authz-rbac",
  • "title": "CMSシステム認可サービス",
  • "description": "CMSシステムの認可サービスです。",
  • "realm": "string",
  • "availabilityManagement": {
    },
  • "singleton": true,
  • "provider": "oidc-authz-provider",
  • "consumers": [ ]
}

Response samples

Content type
application/json
{
  • "name": "authz-rbac",
  • "hub": "urn:chip-in:network:example-realm:hub1",
  • "urn": "urn:chip-in:service:example-realm:hub1:authz-rbac",
  • "title": "CMSシステム認可サービス",
  • "description": "CMSシステムの認可サービスです。",
  • "realm": "string",
  • "availabilityManagement": {
    },
  • "singleton": true,
  • "provider": "oidc-authz-provider",
  • "consumers": [ ]
}

Finds Services

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which service belogs to

hubName
required
string

Name of hub which service belogs to

query Parameters
object (QueryParameter)

Query parameters for filtering services

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find service by urn.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which service belogs to

hubName
required
string

Name of hub which service belogs to

serviceName
required
string

URN of service to return

Responses

Response samples

Content type
application/json
{
  • "name": "authz-rbac",
  • "hub": "urn:chip-in:network:example-realm:hub1",
  • "urn": "urn:chip-in:service:example-realm:hub1:authz-rbac",
  • "title": "CMSシステム認可サービス",
  • "description": "CMSシステムの認可サービスです。",
  • "realm": "string",
  • "availabilityManagement": {
    },
  • "singleton": true,
  • "provider": "oidc-authz-provider",
  • "consumers": [ ]
}

Deletes a service.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which service belogs to

hubName
required
string

Name of hub which service belogs to

serviceName
required
string

Service URN to delete

Responses

Response samples

Content type
application/json
{
  • "name": "authz-rbac",
  • "hub": "urn:chip-in:network:example-realm:hub1",
  • "urn": "urn:chip-in:service:example-realm:hub1:authz-rbac",
  • "title": "CMSシステム認可サービス",
  • "description": "CMSシステムの認可サービスです。",
  • "realm": "string",
  • "availabilityManagement": {
    },
  • "singleton": true,
  • "provider": "oidc-authz-provider",
  • "consumers": [ ]
}

subdomain

Update an existing subdomain.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which zone belogs to

zone
required
string

Name of zone which subdomain belogs to

Request Body schema: application/json
required

Update an existent subdomain in the API gateway.

name
required
string^([a-z0-9][a-z0-9-]*|@)$

サブドメインの名前。ゾーン名と結合して FQDN を得ることができる。 文字列は小文字英字、数字、ハイフンのみを含むことができる。 ただし、先頭がハイフンであってはならない。 たとえば、 stg というサブドメイン名でゾーンの名前が example.com の場合、 stg.example.com というサブドメインを構成し、www.stg.example.com, login.stg.example.com というような FQDN の仮想ホストを収容することができる。 特別なサブドメイン名 "@" は、ゾーンのFQDNそのものを表し、ゾーン直下の仮想ホストを収容する。

title
required
string

サブドメインの名称です。

description
string

サブドメインの説明文です。

destinationRealm
string

このサブドメインの貸出先レルムののURN。

shareCookie
boolean
Default: false

このフラグが指定されると、配下の仮想ホストの間でセッション Cookie が共有される。 すなわち、仮想ホストから発行せれるセッション Cookie の domain 属性にはサブドメインのFQDNが指定される。 デフォルトでは Cookie に Domain 属性は設定されない。 サブドメイン配下の仮想ホストのアクセスログ間でセッションによる串刺しが可能になり、シングルサインオンも実装される。 OIDCやSAMLによるシングルサインオンとは異なり、認証サーバへのリダイレクトは不要となる。

Responses

Request samples

Content type
application/json
{
  • "name": "stg",
  • "title": "CMSシステム",
  • "description": "CMSシステムのWebUI を提供するサブドメインです。",
  • "destinationRealm": "urn:chip-in:realm:example-realm",
  • "shareCookie": true
}

Response samples

Content type
application/json
{
  • "name": "stg",
  • "fqdn": "stg.example.com",
  • "zone": "urn:chip-in:zone:example-realm:example.com",
  • "urn": "urn:chip-in:subdomain:example-realm:example.com:stg",
  • "title": "CMSシステム",
  • "description": "CMSシステムのWebUI を提供するサブドメインです。",
  • "destinationRealm": "urn:chip-in:realm:example-realm",
  • "shareCookie": true
}

Add a new subdomain to the zone.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which zone belogs to

zone
required
string

Name of zone which subdomain belogs to

Request Body schema: application/json
required

Create a new subdomain in the zone

name
required
string^([a-z0-9][a-z0-9-]*|@)$

サブドメインの名前。ゾーン名と結合して FQDN を得ることができる。 文字列は小文字英字、数字、ハイフンのみを含むことができる。 ただし、先頭がハイフンであってはならない。 たとえば、 stg というサブドメイン名でゾーンの名前が example.com の場合、 stg.example.com というサブドメインを構成し、www.stg.example.com, login.stg.example.com というような FQDN の仮想ホストを収容することができる。 特別なサブドメイン名 "@" は、ゾーンのFQDNそのものを表し、ゾーン直下の仮想ホストを収容する。

title
required
string

サブドメインの名称です。

description
string

サブドメインの説明文です。

destinationRealm
string

このサブドメインの貸出先レルムののURN。

shareCookie
boolean
Default: false

このフラグが指定されると、配下の仮想ホストの間でセッション Cookie が共有される。 すなわち、仮想ホストから発行せれるセッション Cookie の domain 属性にはサブドメインのFQDNが指定される。 デフォルトでは Cookie に Domain 属性は設定されない。 サブドメイン配下の仮想ホストのアクセスログ間でセッションによる串刺しが可能になり、シングルサインオンも実装される。 OIDCやSAMLによるシングルサインオンとは異なり、認証サーバへのリダイレクトは不要となる。

Responses

Request samples

Content type
application/json
{
  • "name": "stg",
  • "title": "CMSシステム",
  • "description": "CMSシステムのWebUI を提供するサブドメインです。",
  • "destinationRealm": "urn:chip-in:realm:example-realm",
  • "shareCookie": true
}

Response samples

Content type
application/json
{
  • "name": "stg",
  • "fqdn": "stg.example.com",
  • "zone": "urn:chip-in:zone:example-realm:example.com",
  • "urn": "urn:chip-in:subdomain:example-realm:example.com:stg",
  • "title": "CMSシステム",
  • "description": "CMSシステムのWebUI を提供するサブドメインです。",
  • "destinationRealm": "urn:chip-in:realm:example-realm",
  • "shareCookie": true
}

Find Subdomains

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which zone belogs to

zone
required
string

Name of zone which subdomain belogs to

query Parameters
object (QueryParameter)

Query parameters for filtering subdomains

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Find subdomain by name.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which zone belogs to

zone
required
string

Name of zone which subdomain belogs to

subdomain
required
string

Name of subdomain to return

Responses

Response samples

Content type
application/json
{
  • "name": "stg",
  • "fqdn": "stg.example.com",
  • "zone": "urn:chip-in:zone:example-realm:example.com",
  • "urn": "urn:chip-in:subdomain:example-realm:example.com:stg",
  • "title": "CMSシステム",
  • "description": "CMSシステムのWebUI を提供するサブドメインです。",
  • "destinationRealm": "urn:chip-in:realm:example-realm",
  • "shareCookie": true
}

Deletes a subdomain.

Authorizations:
bearerAuth
path Parameters
realm
required
string

relam which zone belogs to

zone
required
string

Name of zone which subdomain belogs to

subdomain
required
string

Virtual Host URN to delete

Responses

Response samples

Content type
application/json
{
  • "name": "stg",
  • "fqdn": "stg.example.com",
  • "zone": "urn:chip-in:zone:example-realm:example.com",
  • "urn": "urn:chip-in:subdomain:example-realm:example.com:stg",
  • "title": "CMSシステム",
  • "description": "CMSシステムのWebUI を提供するサブドメインです。",
  • "destinationRealm": "urn:chip-in:realm:example-realm",
  • "shareCookie": true
}