ユーザーのすべてのアカウントの取得
get
/iam/governance/selfservice/api/v1/accounts
ユーザーにプロビジョニングされているすべてのアカウントのリストを返します。例: ユーザーにプロビジョニングされているアカウントのリストを取得するには、URIは/account?userid={userKey}となります。アプリケーション・インスタンスにプロビジョニングされているすべてのアカウントを取得するには、URL /accounts?appInstance={applicationInstanceName}を使用します。
リクエスト
サポートされているメディア・タイプ
- application/json
問合せパラメータ
- appInstance(optional): string
アプリケーション・インスタンスの名前を指定して、プロビジョニングされているアカウントをすべて取得します。
- fields(optional): string
結果に返される属性。カンマ区切り属性を受け入れます。属性のサンプル値は、"accountName、accountStatus、accoutType、resource、applicationInstance"です
- q(optional): string
レコードを取得する検索フィルタ。SCIMフィルタを受け入れます。属性値に空白は使用できません。属性値に空白を渡す場合、"::"に置き換えます。フィルタのサンプル値は、accountStatus eq Provisionedです。
- userid(optional): string
ユーザーIDの問合せパラメータによって、指定されたユーザーのアカウントを取得できます。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
成功
ヘッダー
- ResponseTime: string
リクエストの処理にかかった時間(ミリ秒)を取得します。
ネストされたスキーマ: BulkAccountGetResponseInstance
型:
ソースを表示
object- accountData(optional):
- accountDescription(optional): string
- accountType(optional): string
- appinstance(optional): object EntityReference
- id(optional): string
- links(optional): array links
- name(optional): string
- normalizeData(optional):
- policyKey(optional): string
- processInstanceKey(optional): string
- provisionedBy(optional): object EntityReference
- provisionedByMechanism(optional): string
- provisionedOnDate(optional): string
- requestId(optional): object EntityReference
- riskSummary(optional): string
- status(optional): string
- userId(optional): string
- validFromDate(optional): string
401レスポンス
未認可
404レスポンス
リソースが見つからない
500レスポンス
内部サーバー・エラー
デフォルト・レスポンス
予期しないエラー
例
この例では、指定されたユーザーのすべてのアカウントを取得します。ここで表示された情報は疑似システムに対するものであり、プロトタイプとして使用します。
cURLの例
curl -H "Content-Type: application/json" -X GET -u username:password https://pseudo.com/iam/governance/selfservice/api/v1/accounts?userId=82
レスポンス本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/accounts?
userId=82&offset=1&limit=10"
},
{
"rel": "first",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/accounts?
userId=82&offset=1&limit=10"
}
],
"count": 2
"hasMore": false,
"totalResult": -1,
"accounts": [
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/accounts/2"
}
],
"id": "2",
"name": "Test5520190311",
"userId": "82",
"appInstanceId": "1",
"requestId": "",
"fields": [
{
"name": "Status",
"value": "Provisioned"
},
{
"name": "Policy Key",
"value": ""
},
{
"name": "Provisioned By",
"value": "1"
},
{
"name": "Risk Summary",
"value": 0
},
{
"name": "Account Data",
"value": []
},
{
"name": "Provisioned-On Date",
"value": "2019-03-11T22:43:11Z"
},
{
"name": "Process Instance Key",
"value": "201"
},
{
"name": "Valid From Date",
"value": "2019-03-11T22:43:11Z"
},
{
"name": "Account Description",
"value": "Test5520190311"
},
{
"name": "Account Type",
"value": "Primary"
},
{
"name": "Normalize Data",
"value": []
}
]
},
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/accounts/1"
}
],
"id": "1",
"name": "test5520180311",
"userId": "82",
"appInstanceId": "2",
"requestId": "",
"fields": [
{
"name": "Status",
"value": "Provisioning"
},
{
"name": "Policy Key",
"value": ""
},
{
"name": "Provisioned By",
"value": "1"
},
{
"name": "Risk Summary",
"value": 0
},
{
"name": "Account Data",
"value": []
},
{
"name": "Provisioned-On Date",
"value": "2019-03-11T22:42:01Z"
},
{
"name": "Process Instance Key",
"value": "200"
},
{
"name": "Valid From Date",
"value": "2019-03-11T22:42:01Z"
},
{
"name": "Account Description",
"value": "test5520180311"
},
{
"name": "Account Type",
"value": "Unknown"
},
{
"name": "Normalize Data",
"value": []
}
]
}
]
}