ジャンプ先

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

ロール階層の取得

get

/iam/governance/selfservice/api/v1/roles/{roleid}/hierarchy

特定のロールIDの階層リストを返します。

リクエスト

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

• application/json

パス・パラメータ

• roleid: string
  階層詳細を取得するためのロールのロールID。ロールから継承される詳細およびロールによって継承される詳細が返されます。フィルタ・パラメータを使用して、ロールのサブセットを返すことができます。継承元の属性および継承先の属性は返されません。

問合せパラメータ

• hierarchyMode(optional): string
  hierarchyMode問合せパラメータはオプションです。サポートされている値は、"direct"および"both"です。デフォルトは、"direct"です
• hierarchyType(optional): string
  hierarchyType問合せパラメータはオプションです。問合せパラメータにより、フィルタして親ロールまたは子ロールを取得できます。サポートされている値は、"inheritsFrom"(親ロールを取得)および"inheritedBy"(子ロールを取得)です。デフォルト値は、"inheritsFrom"です
• q(optional): string
  レコードを取得する検索フィルタ。たとえば、継承元または継承先に基づいて検索します。検索フィルタを指定しない場合、ロールの取得元と取得先の両方が返されます。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

成功

ヘッダー

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

本文()

ルート・スキーマ: RoleHierarchyGetResponse

型: object

ソースを表示

• inheritedBy(optional): array inheritedBy
• inheritedFrom(optional): array inheritedFrom

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

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

型: array

ソースを表示

• [0]: object Role

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

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

型: array

ソースを表示

• [0]: object 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

ソースを表示

• [0]: object Fields

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

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

型: array

ソースを表示

• [0]: object 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レスポンス

内部サーバー・エラー

先頭に戻る

例

この例では、ロールの階層を取得する機能を示します。この例では、hierarchyTypeおよびinheritsFromによってリクエストをフィルタします。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。

cURLの例

curl  -H "Content-Type: application/json"  -X GET  -u username:password  https://pseudo.com/iam/governance/selfservice/api/v1/roles/7/hierarchy?hierarchyType=inheritsfrom&hierarchyMode=direct

GETレスポンス本文の例

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

{
  "totalResult": 2,
  "roles": [
    {
      "displayname": "role11",
      "id": "47",
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/roles/47"
        }
      ],
      "name": "role11"
    },
    {
      "displayname": "Role2",
      "id": "27",
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/roles/27"
        }
      ],
      "name": "Role2"
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "http://pseudo.com/iam/governance/selfservice/api/v1/roles/7/hierarchy"
    }
  ],
  "count": 2
}

先頭に戻る