ポリシーの取得
get
/iam/governance/selfservice/api/v1/policies
指定されたタイプのすべてのアクセス権、ユーザー名および承認ポリシーを返します。その他のフィルタを追加して、絞り込むことができます。たとえば、Aで始まる名前および従業員のロール(roleID=1234)を持つすべてのアクセス・ポリシーを取得するには、URIは/policies?policyType=accessPolicy&roleid=1234&q=name sw "A"となります。これは、様々なタイプのポリシーの詳細を取得するために使用できます。つまり、A)アクセス・ポリシー: URIは/policies?policyType=accessPolicyとなります B)パスワード・ポリシー: URIは/policies?policyType=passwordPolicyとなります C)承認ポリシー: URIは/policies?approvalPolicyとなります D)ユーザー名ポリシー(ユーザー・ログインの生成に使用): URIは/policies?usernamePolicyとなります
リクエスト
サポートされているメディア・タイプ
- application/json
問合せパラメータ
- fields(optional): string
結果に返される属性。ポリシーIDは、戻りリストの属性で必須です。カンマ区切り属性を受け入れます。
- orgId(optional): string
指定された組織に関連付けられたパスワード・ポリシーを返します。"policyType"が"passwordPolicy"の場合、組織ID問合せパラメータは有効です。
- policyType: string
policyType問合せパラメータで指定されるタイプのポリシーを取得できます。サポートされている値は、"usernamePolicy、accessPolicyおよびapprovalPolicy"です。
- q: string
フィルタにより、policyType問合せパラメータで指定されるタイプのポリシーのサブセットを取得できます。SCIMフィルタを受け入れます。属性値に空白は使用できません。属性値に空白を渡す場合、"::"に置き換えます。
- roleId(optional): string
指定されたロールに関連付けられたアクセス・ポリシーを返します。"policyType"が"accessPolicy"の場合、ロールID問合せパラメータは有効です。
- userId(optional): string
指定されたユーザーに関連付けられたパスワード・ポリシーを返します。"policyType"が"passwordPolicy"の場合、ユーザーID問合せパラメータは有効です。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
成功
ヘッダー
- ResponseTime: string
リクエストの処理にかかった時間(ミリ秒)を取得します。
401レスポンス
未認可
404レスポンス
リソースが見つからない
500レスポンス
内部サーバー・エラー
デフォルト・レスポンス
予期しないエラー
例
この例では、タイプがpasswordPolicyのすべてのポリシーを取得します。ここで表示された情報は疑似システムに対するものであり、プロトタイプとして使用します。
cURLの例
curl -H "Content-Type: application/json" -X GET -u username:password https://pseudo.com/iam/governance/selfservice/api/v1/policies?policyType=passwordpolicy
GETレスポンス本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
{ "links": [ { "rel": "self", "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/policies? policyType=passwordpolicy&offset=1&limit=10" }, { "rel": "first", "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/policies? policyType=passwordpolicy&offset=1&limit=10" } ], "count": 1, "hasMore": false, "totalResult": -1, "policies": [ { "links": [ { "rel": "self", "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/policies/1? policyType=passwordPolicy" } ], "id": "1", "pwr_name": "Default Policy", "pwr_desc": "This is the Default OIM Password Policy", "rules": [ "Password must not match or contain first name.", "Password must not match or contain last name.", "Password must contain at least 2 alphabetic character(s).", "Password must be at least 8 character(s) long.", "Password must contain at least 1 lowercase letter(s).", "Password must contain at least 1 numeric character(s).", "Password must contain at least 1 uppercase letter(s).", "Password must start with an alphabetic character.", "Password must not match or contain user ID." ] } ] }