ジャンプ先

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

useridおよびidstorerefを使用したユーザー・ステータスの取得

get

/oam/services/rest/access/api/v1/pswdmanagement/UserStatusRetriever/${userid}/${idstoreref}'

入力ユーザーのユーザー・ステータスが取得されます。useridとidentitystorerefがこのAPIのパス・パラメータとして指定されます。idstorerefが必要になるのは、ユーザーがOAMのデフォルト・アイデンティティ・ストア以外のアイデンティティ・ストアに存在する場合です。

リクエスト

パス・パラメータ

• idstoreref: string
  ユーザーが属するidstore
• userid: string
  ユーザーを一意に識別する入力

問合せパラメータ

• userdetails(optional): string
  問合せパラメータのuserdetailsオブジェクト

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

ユーザー・ステータスが正常に取得されました

本文()

ルート・スキーマ: UserStatusChangeRequest

型: object

ソースを表示

• enabled(optional): boolean
  ユーザーが有効な場合、trueに設定します。無効な場合、falseに設定します
• forcepwdchange(optional): boolean
  ユーザーが次のログインでパスワードを強制的に変更する場合、trueに設定します。それ以外の場合、falseに設定します。
• unlocked(optional): boolean
  ユーザーのロックが解除されている場合、trueに設定します。ユーザーがロックされている場合、falseに設定します
• username(optional): object userdetails

{
    "type":"object",
    "properties":{
        "username":{
            "$ref":"#/definitions/userdetails"
        },
        "enabled":{
            "type":"boolean",
            "description":"if user is enabled, set to true. If disabled, set as false"
        },
        "unlocked":{
            "type":"boolean",
            "description":"if user is unlocked, set to true. If user is locked, set to false"
        },
        "forcepwdchange":{
            "type":"boolean",
            "description":"if user is forced to change password in the next login, set to true. Else set to false."
        }
    }
}

ネストされたスキーマ: userdetails

型: object

ソースを表示

• dn(optional): string
  アイデンティティ・ストア内のユーザーの識別名
• idstoreref(optional): string
  ユーザーが属するidstore
• tenantname(optional): string
  テナント名。常にsystemTenantです
• username(optional): string
  ユーザーの短縮名

{
    "type":"object",
    "properties":{
        "tenantname":{
            "type":"string",
            "description":"tenant name. Its always systemTenant"
        },
        "idstoreref":{
            "type":"string",
            "description":"idstore that the user belongs to"
        },
        "dn":{
            "type":"string",
            "description":"the distinguished name of the user in the identity store"
        },
        "username":{
            "type":"string",
            "description":"the short name of the user"
        }
    }
}

401 レスポンス

未認可

404 レスポンス

リクエスト・エンティティが見つからない

500 レスポンス

内部サーバー・エラー

先頭に戻る