ジャンプ先

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

すべての組織の取得。

get

/iam/governance/selfservice/api/v1/organizations

ログイン・ユーザーに割り当てられた組織を返します。フィルタ問合せパラメータを使用して、組織のサブセットを取得します。SCIMフィルタを受け入れます。たとえば、名前がOracleで始まるすべての組織を取得する問合せは、/organization?q=name sw Oracleです。組織によって返される属性は、属性問合せパラメータを指定して制御することもできます。属性名のカンマ区切りリストは属性問合せパラメータに渡されます。たとえば、組織名および説明のみを取得するには、URIは/organization?fields=name, descriptionとなります。

リクエスト

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

• application/json

問合せパラメータ

• fields(optional): string
  組織によって返される属性は、属性問合せパラメータを指定して制御することもできます。属性名のカンマ区切りリストは属性問合せパラメータに渡されます。たとえば、組織名および説明のみを取得するには、URIは/organization?fields=name, descriptionとなります。
• q(optional): string
  フィルタは"entityType"に適用できます。これに指定可能な値はRoleであり、該当する組織の"roleid"が取得されます。ここでは、フィルタ値に空白を含むことはできません。フィルタのサンプル値は、"entityType eq Role"または"entityType eq Role and roleid={roleId}"です。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

成功

ヘッダー

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

本文()

ルート・スキーマ: OrganizationResponse

型: object

ソースを表示

• count(optional): integer
• hasMore(optional): boolean
• links(optional): array links
• organizations(optional): array organizations
• totalResult(optional): integer

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResult":{
            "type":"integer"
        },
        "organizations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/OrganizationResponseMap"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

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

型: array

ソースを表示

• [0]: object LinkDataInstances

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

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

型: array

ソースを表示

• [0]: object OrganizationResponseMap

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

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

型: object

ソースを表示

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

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

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

型: 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"
        }
    }
}

401レスポンス

未認可

404レスポンス

リソースが見つからない

500レスポンス

内部サーバー・エラー

デフォルト・レスポンス

予期しないエラー

先頭に戻る

例

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

cURLの例

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

GETレスポンス本文の例

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

{
  "links": [
    {
      "rel": "self",
      "href": "http://pseudo.com/iam/governance/selfservice/api/v1/organizations"
    }
  ],
  "count": 2,
  "organization": [
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/organizations/5"
        }
      ],
      "id": 5,
      "fields": {
        "Certifier User Key": null,
        "Applicable Password Policy": 1,
        "Certifier User Login": null,
        "Organization Status": "Active",
        "Parent Organization Name": "Top",
        "Organization Name": "Org2",
        "act_updateby": 1,
        "act_key": 5,
        "Password Policy": null,
        "Organization Customer Type": "Company",
        "Password Policy Name": null,
        "parent_key": 3,
        "User Membership Rule": null,
        "act_createby": 1,
        "act_create": 1456833264000,
        "act_data_level": null,
        "act_update": 1456833264000,
        "Applicable Password Policy Name": null,
        "Enforce New Password Policy": "Yes",
        "act_disabled": null
      }
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/organizations/4"
        }
      ],
      "id": 4,
      "fields": {
        "Certifier User Key": null,
        "Applicable Password Policy": 1,
        "Certifier User Login": null,
        "Organization Status": "Active",
        "Parent Organization Name": "Top",
        "Organization Name": "Org1",
        "act_updateby": 1,
        "act_key": 4,
        "Password Policy": null,
        "Organization Customer Type": "Company",
        "Password Policy Name": null,
        "parent_key": 3,
        "User Membership Rule": null,
        "act_createby": 1,
        "act_create": 1456819726000,
        "act_data_level": null,
        "act_update": 1456819726000,
        "Applicable Password Policy Name": null,
        "Enforce New Password Policy": "Yes",
        "act_disabled": null
      }
    }
  ]
}

先頭に戻る