ジャンプ先

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

ユーザーの取得

get

/iam/governance/selfservice/api/v1/users

ログイン・ユーザーに表示可能なOracle Identity Manager内のすべてのユーザーを返します。ユーザーは、フィルタ問合せパラメータで指定された基準に基づいてフィルタできます。たとえば、姓がGで始まるすべてのユーザーを取得するには、URIは/users?q=Last::Name sw 'G'となります。ユーザー定義フィールド(UDF)を含むユーザーのすべての属性は、レスポンス・ペイロードの一部として返されます。レスポンス・ペイロードは、"fields"問合せパラメータで必要な属性を指定することにより管理できます。

リクエスト

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

• application/json

問合せパラメータ

• fields(optional): string
  結果に返される属性。カンマ区切り属性を受け入れます。属性のサンプル値は、"First Name、Middle Name、Last Name、Email、User Login、Employee Number、Manager Login、Department Number"です
• q(optional): string
  レコードを取得する検索フィルタ。SCIMフィルタを受け入れます。属性値に空白は使用できません。属性値に空白を渡す場合、"::"に置き換えます。フィルタのサンプル値は、"User::Login eq avinkまたはLast Name eq kamboj"です。含まれているエンティティの属性にフィルタを適用することはできません。たとえば、マネージャの姓がZで始まるユーザー(/users?q=Manager.Last::Name sw 'Z')をフィルタすることはできません。検索可能として構成されているフィールドをフィルタの一部として指定できます。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

成功

ヘッダー

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

本文()

ルート・スキーマ: UsersListResponse

型: object

ソースを表示

• count(optional): integer
• hasMore(optional): boolean
• totalResult(optional): integer
• users(optional): array users

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResult":{
            "type":"integer"
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserBulkInstances"
            }
        }
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト UserBulkInstances

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

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

型: object

ソースを表示

• fields(optional): array fields
• id(optional): string
• links(optional): array links

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

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

型: array

ソースを表示

• 配列: オブジェクト Fields

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

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

型: array

ソースを表示

• 配列: オブジェクト LinkDataInstances

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

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

型: object

ソースを表示

• name(optional): string
• value(optional): string

{
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

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

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

401レスポンス

未認可

404レスポンス

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

500レスポンス

内部サーバー・エラー

先頭に戻る