ジャンプ先

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

組織の詳細の取得。

get

/iam/governance/selfservice/api/v1/organizations/{orgid}

パス・パラメータの組織IDで指定された組織の詳細を返します。組織によって返される属性は、属性問合せパラメータを指定して制御することもできます。属性名のカンマ区切りリストは属性問合せパラメータに渡されます。たとえば、組織名および説明のみを取得するには、URIは/organization?fields=name, descriptionとなります。

リクエスト

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

• application/json

パス・パラメータ

• orgid: string
  組織ID

問合せパラメータ

• fields(optional): string
  組織に返される属性は、属性問合せパラメータを指定して制御することもできます。属性名のカンマ区切りリストは属性問合せパラメータに渡されます。たとえば、組織名および説明のみを取得するには、URIは/organization/{orgid}?fields=name, descriptionとなります。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

成功

ヘッダー

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

本文()

ルート・スキーマ: OrganizationIdResponse

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

内部サーバー・エラー

デフォルト・レスポンス

予期しないエラー

先頭に戻る

例

この例では、組織名および親組織名でフィルタされる戻りフィールドを含む組織を取得します。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。

cURLの例

curl  -H "Content-Type: application/json"  -X GET  -u username:password  "https://pseudo.com/iam/governance/selfservice/api/v1/organizations/4?fields=Organization Name,Parent Organization Name"

レスポンス本文の例

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

{
  "links": [
    {
      "rel": "self",
      "href": "http://pseudo.com/iam/governance/selfservice/api/v1/organizations/4"
    }
  ],
  "id": 4,
  "fields": [
    {
      "name": "Parent Organization Name",
      "value": "Top"
    },
    {
      "name": "Organization Name",
      "value": "Org1"
    }
  ]
}

先頭に戻る