ジャンプ先

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

すべての組織の取得

get

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

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

リクエスト

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

• application/json

問合せパラメータ

• fields(optional): string
  組織によって返される属性は、属性問合せパラメータを指定して制御することもできます。属性名のカンマ区切りリストは属性問合せパラメータに渡されます。たとえば、組織名および説明のみを取得するには、URIは"/organizations?fields=Organization Name"となります。
• 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

ソースを表示

• 配列: オブジェクト LinkDataInstances

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

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

型: array

ソースを表示

• 配列: オブジェクト 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

ソースを表示

• 配列: オブジェクト 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"
        }
    }
}

401レスポンス

未認可

404レスポンス

リソースが見つからない

500レスポンス

内部サーバー・エラー

デフォルト・レスポンス

予期しないエラー

先頭に戻る

例

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

cURLの例

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

GETレスポンス本文の例

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

{
    "links": [
        {
            "rel": "self",
            "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/organizations?
offset=1&limit=10"
        },
        {
            "rel": "first",
            "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/organizations?
offset=1&limit=10"
        }
    ],
    "count": 1,
    "hasMore": false,
    "totalResult": -1,
    "organizations": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/organizations/1"
                }
            ],
            "id": "1",
            "fields": [
                {
                    "name": "Applicable Password Policy",
                    "value": 1
                },
                {
                    "name": "Parent Organization Name",
                    "value": "Top"
                },
                {
                    "name": "act_create",
                    "value": "2019-03-29T20:14:27Z"
                },
                {
                    "name": "Organization Name",
                    "value": "Xellerate Users"
                },
                {
                    "name": "parent_key",
                    "value": 3
                },
                {
                    "name": "act_createby",
                    "value": 1
                },
                {
                    "name": "Organization Status",
                    "value": "Active"
                },
                {
                    "name": "act_data_level",
                    "value": 1
                },
                {
                    "name": "act_updateby",
                    "value": 1
                },
                {
                    "name": "Organization Customer Type",
                    "value": "System"
                },
                {
                    "name": "act_update",
                    "value": "2019-03-29T20:14:27Z"
                },
                {
                    "name": "Enforce New Password Policy",
                    "value": "Yes"
                }
            ]
        }
    ]
}

先頭に戻る