Skip to main content
POST
IDプロバイダーを作成する

承認

Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

ボディ

application/json

IDプロバイダー固有のオプションです。

name
string
必須

IDプロバイダーの名前

Required string length: 1 - 128
strategy
enum<string>
必須

IDプロバイダーの種類

利用可能なオプション:
adfs,
google-apps,
oidc,
okta,
pingfederate,
samlp,
waad
Allowed value: "adfs"
options
adfs_server · object
必須

IDプロバイダー固有のオプションです。

assign_membership_on_login
boolean

true の場合、ユーザーはログイン時に組織のメンバーになります。

display_name
string

ログイン画面で使用される IDプロバイダー名。

Required string length: 1 - 128
domains
string[]

ホーム レルム ディスカバリー(HRD)用のドメイン一覧

is_enabled
boolean

IDプロバイダーが組織で有効になっている場合は true。

show_as_button
boolean

ログインページにこの接続のボタンを表示できるようにします(新しいエクスペリエンスのみ)。false の場合、ホーム レルム ディスカバリー(HRD)でのみ使用できます。

レスポンス

IDプロバイダーが正常に作成されました。

IDプロバイダー固有のオプションです。

strategy
enum<string>
必須

IDプロバイダーの種類

利用可能なオプション:
adfs,
google-apps,
oidc,
okta,
pingfederate,
samlp,
waad
Allowed value: "adfs"
options
adfs_server · object
必須

IDプロバイダー固有のオプションです。

access_level
enum<string>
read-only
利用可能なオプション:
none,
readonly,
limited,
full
assign_membership_on_login
boolean

true の場合、ユーザーはログイン時に組織のメンバーになります。

display_name
string

ログイン画面で使用される IDプロバイダー名。

Required string length: 1 - 128
domains
string[]

ホーム レルム ディスカバリー(HRD)用のドメイン一覧

id
string
read-only

IDプロバイダーの識別子。

Pattern: ^con_[A-Za-z0-9]{16}$
is_enabled
boolean

IDプロバイダーが組織で有効になっている場合は true。

name
string | null

IDプロバイダーの名前

Maximum string length: 128
show_as_button
boolean

ログインページにこの接続のボタンを表示できるようにします(新しいエクスペリエンスのみ)。false の場合、ホーム レルム ディスカバリー(HRD)でのみ使用できます。