ジャンプ先

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

指定されたユーザーのステータスの取得。

get

/iam/governance/selfservice/api/v1/users/{uuid}/status

指定されたユーザーのステータスを返します。返される値は、ユーザーのOIMでの状態によって異なります。想定される値は、"Active、Disabled、Deleted、Disabled Until Start Date"です。

リクエスト

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

• application/json

パス・パラメータ

• uuid: string
  ステータスが返されるユーザーの一意識別子。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

成功

ヘッダー

• ResponseTime: string
  リクエストの処理にかかった時間(ミリ秒)を取得します。

本文()

ルート・スキーマ: StatusResponse

型: object

ソースを表示

• id(optional): string
• links(optional): array links
• name(optional): string
• status(optional): string

{
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

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

型: object

ソースを表示

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

401レスポンス

未認可

404レスポンス

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

500レスポンス

内部サーバー・エラー

先頭に戻る

例

ここでは、指定されたユーザーのステータスを取得します。ここで表示された情報は疑似システムに対するものであり、プロトタイプとして使用します。

cURLの例

curl  -H "Content-Type: application/json"  -X GET  -u username:password  https://pseudo.com/iam/governance/selfservice/api/v1/users/1/status

GETレスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
    "links": [
        {
            "rel": "self",
            "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/24/status"
        }
    ],
    "status": "Active",
    "id": "24",
    "name": "Beatrix Kiddo",
    "usr_locked": "0"
}

先頭に戻る