ジャンプ先

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

ロールの取得

get

/iam/governance/selfservice/api/v1/roles

Oracle Identity Managerのすべてのロールを返します。フィルタ問合せパラメータを使用して、ロールのサブセットを取得します。SCIMフィルタを受け入れます。たとえば、名前がOracleで始まるすべてのロールを取得する問合せは、"/role?q=Role::Name sw Oracle"です。ロールで返される属性は、fields問合せパラメータを指定して制御することもできます。

リクエスト

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

• application/json

問合せパラメータ

• fields(optional): string
  属性名のカンマ区切りリストはfields問合せパラメータに渡されます。たとえば、ロールの表示名、一意の名前および説明のみを取得するには、URIは"/role?fields=Role Unique Name,Role Display Name,Role Description"となります。レスポンスには、ロールの一意識別子であるロール・キーおよびロールIDが含まれています。
• q(optional): string
  レコードを取得する検索フィルタ。SCIMフィルタを受け入れます。属性名に空白は使用できません。属性名に空白を渡す場合、"::"に置き換えます。フィルタでサポートされている属性は、"Role Name"などです。フィルタのサンプル値は、"Role::Name sw Oracle"です

先頭に戻る

レスポンス

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

• application/json

200レスポンス

成功

ヘッダー

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

本文()

ルート・スキーマ: BulkRoleGetResponse

型: object

ソースを表示

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

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

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

型: array

ソースを表示

• 配列: オブジェクト Role

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

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

型: 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レスポンス

内部サーバー・エラー

先頭に戻る