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

idp-server コントロールプレーン 認証設定管理 API (1.0.0)

Download OpenAPI specification:Download

認証設定、認証ポリシー、認証インタラクション、認証トランザクションの管理API仕様書

organization-authentication-interaction

組織レベル認証インタラクション管理

組織内認証インタラクション一覧取得

指定した組織・テナント内の認証インタラクション一覧を取得します(読み取り専用)

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 20

返すアイテムの最大数

offset
integer >= 0
Default: 0

アイテムを返す開始インデックス

transaction_id
string <uuid>

認証トランザクションIDでフィルタリング

interaction_type
string

インタラクションタイプでフィルタリング

status
string
Enum: "pending" "completed" "failed" "expired"

ステータスでフィルタリング

created_at_from
string <date-time>

作成日時の範囲指定開始

created_at_to
string <date-time>

作成日時の範囲指定終了

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total_count": 25,
  • "limit": 10,
  • "offset": 0
}

組織内認証インタラクション詳細取得

指定した組織・テナント内の特定の認証インタラクションの詳細を取得します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

transaction-id
required
string <uuid>
Example: f47ac10b-58cc-4372-a567-0e02b2c3d479

認証トランザクションID

type
required
string
Example: password

インタラクションタイプ

Responses

Response samples

Content type
application/json
{
  • "transaction_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  • "type": "password",
  • "payload": {
    }
}

organization-authentication-transaction

組織レベル認証トランザクション管理

組織内認証トランザクション一覧取得

指定した組織・テナント内の認証トランザクション一覧を取得します(読み取り専用)

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 20

返すアイテムの最大数

offset
integer >= 0
Default: 0

アイテムを返す開始インデックス

status
string
Enum: "pending" "completed" "failed" "expired"

トランザクションステータスでフィルタリング

client_id
string

クライアントIDでフィルタリング

created_at_from
string <date-time>

作成日時の範囲指定開始

created_at_to
string <date-time>

作成日時の範囲指定終了

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total_count": 15,
  • "limit": 10,
  • "offset": 0
}

組織内認証トランザクション詳細取得

指定した組織・テナント内の特定の認証トランザクションの詳細を取得します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

transaction-id
required
string <uuid>
Example: f47ac10b-58cc-4372-a567-0e02b2c3d479

認証トランザクションID

Responses

Response samples

Content type
application/json
{
  • "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  • "client_id": "example-client-001",
  • "redirect_uri": "https://example.com/callback",
  • "scope": "openid profile email",
  • "state": "random-state-value",
  • "nonce": "random-nonce-value",
  • "response_type": "code",
  • "code_challenge": "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk",
  • "code_challenge_method": "S256"
}

organization-authentication-config

Create authentication configuration within organization

組織内の特定のテナントに対して新しい認証設定を作成します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

query Parameters
dry_run
boolean
Default: false

trueの場合、リクエストの検証のみで実行はされません

Request Body schema: application/json
optional
id
string <uuid>

設定識別子

type
string

認証設定タイプ

object

Configuration-specific attributes

object

設定メタデータ

object

認証インタラクション設定 mapping

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "string",
  • "attributes": { },
  • "metadata": { },
  • "interactions": {
    }
}

Response samples

Content type
application/json
{
  • "dry_run": true,
  • "result": {
    }
}

List authentication configurations within organization

組織内の特定のテナントの認証設定一覧を取得します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 20

返すアイテムの最大数

offset
integer >= 0
Default: 0

アイテムを返す開始インデックス

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total_count": 0,
  • "limit": 0,
  • "offset": 0
}

Get authentication configuration by ID within organization

組織内の特定のテナントの認証設定詳細を取得します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

config-id
required
string <uuid>

認証設定の識別子

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "string",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "attributes": { },
  • "metadata": { },
  • "interactions": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update authentication configuration by ID within organization

組織内の特定のテナントの認証設定を更新します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

config-id
required
string <uuid>

認証設定の識別子

query Parameters
dry_run
boolean
Default: false

trueの場合、リクエストの検証のみで実行はされません

Request Body schema: application/json
optional
id
string <uuid>

設定識別子

type
string

認証設定タイプ

object

Configuration-specific attributes

object

設定メタデータ

object

認証インタラクション設定 mapping

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "string",
  • "attributes": { },
  • "metadata": { },
  • "interactions": {
    }
}

Response samples

Content type
application/json
{
  • "dry_run": true,
  • "result": {
    }
}

Delete authentication configuration by ID within organization

組織内の特定のテナントの認証設定を削除します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

config-id
required
string <uuid>

認証設定の識別子

query Parameters
dry_run
boolean
Default: false

trueの場合、リクエストの検証のみで実行はされません

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "config_id": "d1d31429-d888-4f1c-b9c1-4e842f9bce5b",
  • "dry_run": true
}

organization-authentication-policy-config

Create authentication policy configuration within organization

組織内の特定のテナントに対して新しい認証ポリシー設定を作成します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

query Parameters
dry_run
boolean
Default: false

trueの場合、リクエストの検証のみで実行はされません

Request Body schema: application/json
optional
id
string <uuid>

Authentication policy configuration identifier

flow
string

Authentication flow type

Array of objects (AuthenticationPolicy)

List of authentication policies

enabled
boolean
Default: true

Whether the policy configuration is enabled

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "flow": "string",
  • "policies": [
    ],
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "dry_run": false,
  • "result": {
    }
}

List authentication policy configurations within organization

組織内の特定のテナントの認証ポリシー設定一覧を取得します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

query Parameters
limit
integer [ 1 .. 1000 ]
Default: 20

返すアイテムの最大数

offset
integer >= 0
Default: 0

アイテムを返す開始インデックス

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "total_count": 0,
  • "limit": 0,
  • "offset": 0
}

Get authentication policy configuration by ID within organization

組織内の特定のテナントの認証ポリシー設定詳細を取得します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

config-id
required
string <uuid>

認証ポリシー設定の識別子

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "flow": "string",
  • "policies": [
    ],
  • "enabled": true,
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update authentication policy configuration by ID within organization

組織内の特定のテナントの認証ポリシー設定を更新します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

config-id
required
string <uuid>

認証ポリシー設定の識別子

query Parameters
dry_run
boolean
Default: false

trueの場合、リクエストの検証のみで実行はされません

Request Body schema: application/json
optional
id
string <uuid>

Authentication policy configuration identifier

flow
string

Authentication flow type

Array of objects (AuthenticationPolicy)

List of authentication policies

enabled
boolean
Default: true

Whether the policy configuration is enabled

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "flow": "string",
  • "policies": [
    ],
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "dry_run": true,
  • "result": {
    }
}

Delete authentication policy configuration by ID within organization

組織内の特定のテナントの認証ポリシー設定を削除します

path Parameters
organization-id
required
string <uuid>

組織の識別子

tenant-id
required
string

テナントの識別子

config-id
required
string <uuid>

認証ポリシー設定の識別子

query Parameters
dry_run
boolean
Default: false

trueの場合、リクエストの検証のみで実行はされません

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string",
  • "error_messages": [
    ],
  • "error_details": { }
}