ジャンプ先

• リクエスト
• レスポンス

SSOサービスの更新

put

/oam/services/rest/11.1.2.0.0/fed/admin/sso

このRESTエンドポイント・リクエストは、顧客がアイデンティティ・プロバイダである場合に、PUTメソッドを使用してSSOサービスを構成するために使用します

リクエスト

サポートされているメディア・タイプ

• application/json
• application/xml
• text/xml

本文()

ssoChooser、ssoFederationおよびoamLogoutDoneURLは、PUT操作を使用して更新できます。

ルート・スキーマ: ConfigureSSOInput

タイプ: object

これらのパラメータはSSOサービスの構成にのみ使用できます。

ソースを表示

• idpLabelLoginPage(required): string
  顧客が個別移入を使用していて、一部はフェデレーションSSOを実行する必要があり、残りは認証のためにローカル・ログインを実行する必要がある場合に、ログインの選択ページのフェデレーションSSOを開始するためのボタンで使用されるラベル(OIFの場合のみ)
• idpProviderID(required): string
  IDPパートナのプロバイダID
• oamAdminHost(required): string
  WLS管理サーバーがインストールされているホスト名。FA専用デプロイメントでのみ使用されます(OIFの場合のみ)
• oamAdminPassword(required): string
  OAM管理コマンドを発行するのに使用されるWLS管理ユーザー名のパスワード。FA専用デプロイメントでのみ使用されます(OIFの場合のみ)
• oamAdminPort(required): string
  WLS管理サーバーがインストールされているポート。FA専用デプロイメントでのみ使用されます(OIFの場合のみ)
• oamAdminUser(required): string
  OAM管理コマンドを発行するのに使用されるWLS管理ユーザー名。FA専用デプロイメントでのみ使用されます(OIFの場合のみ)
• oamLogoutDoneURL(required): string
  ログアウト後にユーザーがリダイレクトされるURL(OIFの場合のみ)
• preverify(required): string
  コールで事前検証チェックを実行するかどうかを示すboolean。trueの場合、後続の呼び出しで変更が実行される前にサービスにおいてフェデレーション・サービスが正しく構成されている必要があります。
• spTenantName(required): string
  ターゲット・サービスにおける顧客のテナント名
• ssoChooser(required): string
  SSOを有効化する必要があるかどうかをtrueまたはfalseで示します(OIFの場合のみ)
• ssoFederation(required): string
  SSOを有効にする必要があるかどうかを示します

{
    "description":"These parameters can be used to configure SSO service.",
    "type":"object",
    "required":[
        "spTenantName",
        "idpProviderID",
        "preverify",
        "ssoFederation",
        "ssoChooser",
        "oamAdminUser",
        "oamAdminPassword",
        "oamAdminHost",
        "oamAdminPort",
        "oamLogoutDoneURL",
        "idpLabelLoginPage"
    ],
    "properties":{
        "spTenantName":{
            "type":"string",
            "description":"the customers' tenant name in the targeted service"
        },
        "idpProviderID":{
            "type":"string",
            "description":"provider ID for the IDP Partner"
        },
        "preverify":{
            "type":"string",
            "description":"boolean indicating if the call is to perform a pre-verification check. If true, the service will need to ensure the Federation service is correctly configured before the changes are performed in a subsequent call."
        },
        "ssoFederation":{
            "type":"string",
            "description":"indicates whether or not SSO should be enabled"
        },
        "ssoChooser":{
            "type":"string",
            "description":"indicates whether or not SSO should be enabled, true or false (ONLY FOR OIF)"
        },
        "oamAdminUser":{
            "type":"string",
            "description":"the WLS Admin username used to issue an OAM admin command. Only used in FA Dedicated deployments (ONLY FOR OIF)"
        },
        "oamAdminPassword":{
            "type":"string",
            "description":"the password for the WLS Admin username used to issue an OAM admin command. Only used in FA Dedicated deployments (ONLY FOR OIF)"
        },
        "oamAdminHost":{
            "type":"string",
            "description":"the hostname where WLS Admin server is installed. Only used in FA Dedicated deployments (ONLY FOR OIF)"
        },
        "oamAdminPort":{
            "type":"string",
            "description":"the port where WLS Admin server is installed. Only used in FA Dedicated deployments (ONLY FOR OIF)"
        },
        "oamLogoutDoneURL":{
            "type":"string",
            "description":"the URL where the user should be redirected after the logout is done (ONLY FOR OIF)"
        },
        "idpLabelLoginPage":{
            "type":"string",
            "description":"the label that will be used on the button to start Federation SSO on the Chooser Login page, when the customer uses disjoint population, where some must do Federation SSO and others must do local login for authentication (ONLY FOR OIF)"
        }
    },
    "xml":{
        "name":"ConfigureSSOInput"
    }
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

OK

本文()

ルート・スキーマ: statusResponse

タイプ: object

ステータス・レスポンス

ソースを表示

• status: integer(int32)
  ステータス・コード: 成功の場合1、失敗の場合0
• statusMessage: string
  ステータス・メッセージ

{
    "description":"Status Response",
    "properties":{
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"Status Code: 1 for success and 0 for failure"
        },
        "statusMessage":{
            "type":"string",
            "description":"Status Message"
        }
    }
}

400レスポンス

不正なリクエスト。

500レスポンス

内部サーバー・エラー。

先頭に戻る