ジャンプ先

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

管理ロールの取得

get

/iam/governance/selfservice/api/v1/adminroles

Oracle Identity Managerで構成されたすべての管理ロールを返します。ユーザーの管理ロールは、フィルタ問合せパラメータを使用すると取得できます。例: /adminrole?q=userid={userId}。アルファベットAで始まる管理ロールをユーザーがフェッチしようとするシナリオでは、フィルタ問合せパラメータを使用できます。例: /adminrole?q=name sw 'A'

リクエスト

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

• application/json

問合せパラメータ

• fields(optional): string
  結果に返される属性。カンマ区切り属性を受け入れます。サポートされている属性のサンプル値は、"ROLE_ID、ROLE_NAME、ROLE_DISPLAY_NAME、DESCRIPTIONおよびCUSTOM"です
• q(optional): string
  レコードを取得する検索フィルタ。SCIMフィルタを受け入れます。属性値に空白は使用できません。属性値に空白を渡す場合、"::"に置き換えます。フィルタでサポートされている属性は、roleNameおよびroleKeyです。フィルタのサンプル値は、"ROLE_DISPLAY_NAME eq ITGRoleまたはROLE_ID eq 8"です。フィルタで使用できる属性名は、ROLE_ID、ROLE_NAME、ROLE_DISPLAY_NAME、DESCRIPTIONおよびCUSTOMです

先頭に戻る

レスポンス

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

• application/json

200レスポンス

成功

ヘッダー

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

本文()

ルート・スキーマ: BulkAdminRoleGetResponse

型: object

ソースを表示

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

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

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

型: array

ソースを表示

• [0]: object AdminRole

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

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

型: object

ソースを表示

• custom(optional): string
• delayedEvaluationSet(optional): string
• description(optional): string
• displayName(optional): string
• id(optional): string
• links(optional): array links
• name(optional): string
• scoped(optional): string

{
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "delayedEvaluationSet":{
            "type":"string"
        },
        "scoped":{
            "type":"string"
        },
        "custom":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

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

型: array

ソースを表示

• [0]: object 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/adminrole?fields=roleId,roleName,roleDisplayName,roleDescription

GETレスポンス本文の例

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

{
  "links": [
    {
      "rel": "self",
      "href": "http://pseudo.com/iam/governance/selfservice/api/v1/adminrole"
    }
  ],
  "count": 4,
  "roles": [
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/adminrole/1"
        }
      ],
      "id": "1",
      "name": "OrclOIMSystemAdministrator",
      "description": "OIM System Administrator Role with All Privileges",
      "displayName": "System Administrator"
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/adminrole/2"
        }
      ],
      "id": "2",
      "name": "OrclOIMSystemConfigurator",
      "description": "Role with privileges to configure OIM application",
      "displayName": "System Configuration Administrator"
    },
    {
      "links": [
        {
          "rel": "self",
          "href"pseudo.com/iam/governance/selfservice/api/v1/adminrole/3"
        }
      ],
      "id": "3",
      "name": "OrclOIMCatalogAdmin",
      "description": "Role can administer all the catalog items",
      "displayName": "Catalog System Administrator"
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/adminrole/4"
        }
      ],
      "id": "4",
      "name": "OrclOIMRoleAdministrator",
      "description": "Role can manage all assigned enterprise roles",
      "displayName": "Role Administrator"
    }
  ]
}

先頭に戻る