2 OPSSクライアントの登録
| セクション | メソッド | リソース・パス |
|---|---|---|
|
|
/opss/v2/ |
|
|
|
/opss/v2/ |
|
|
|
/opss/v2/ |
|
|
|
/opss/v2/ |
登録のPOSTメソッド
注意:
登録データに変更を加える際にクライアントを識別するには、同じclientName属性値が必要です。
RESTリクエスト
POST /opss/v2/opssRestClient/
リクエスト本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
リクエスト本文には、登録リクエストの詳細が含まれます。
表2-1 登録属性
| 属性 | 説明 | 必須 |
|---|---|---|
|
|
クライアントを識別する一意の名前。 |
はい |
|
|
クライアントが割り当てられるポリシー・ストア・ストライプ。 |
いいえ |
|
|
クライアントに使用されるキーストアのリスト。 |
いいえ |
|
|
資格証明キーの格納に使用される資格証明マップの名前。 |
いいえ |
|
|
クライアントの監査ルールを識別する一意の名前。 |
いいえ |
|
|
トラスト・トークンを発行できるアイデンティティ・ドメインのリスト |
いいえ |
|
|
トラスト・トークンを検証できるリスト・アイデンティティ・ドメイン |
いいえ |
|
|
管理者ロールのグループ。 |
いいえ |
|
|
オペレータ・ロールを使用したグループ。 |
いいえ |
|
|
ビューア・ロールを使用したグループ。 |
いいえ |
clientName以外のすべての属性は複数回指定できます。ユーザーはサービス・スコープに少なくとも次のいずれかを指定する必要があります: policystoreStripe、keystore、credentialMap、auditComponent、trustIssueIDDまたはtrustValidateIDD。さらに、いくつかのグループが権限を持つために、ユーザーは次のいずれかを指定する必要があります: adminGroup、operatorGroupまたはviewerGroup。
サービス・スコープ属性では、ワイルド・カード(*)を指定して、すべてのスコープをクライアントに指定することができます。ワイルドカードは慎重に使用する必要があります。
レスポンス本文
POSTリクエストの出力はリソースIDです。
cURLの例
次の例は、cURLを使用してRESTリソースにPOSTリクエストを発行してクライアントを登録する方法を示しています
curl -i -X POST -u username:password --data @register.json -H Content-Type:application/json https://myhost:7001/opss/v2/opssRestClient
リクエスト本文の例
JSON形式のリクエスト本文の例を次に示します。
{
"clientName": "myClientName",
"policystoreStripe": "CRM",
"keystore": ["appA", "appB/store1"],
"credentialMap": "mapA",
"auditComponent": "myComponent",
"trustIssueIDD" : ["cisco", "intel"],
"trustValidateIDD" : ["cisco", "intel"],
"adminGroup":"myGroup1",
"operatorGroup":"myGroup2",
"viewerGroup":"myGroup3"
}
登録のGETメソッド
登録されたクライアントのクライアント属性を表示するには、GETメソッドを使用します。
RESTリクエスト
GET /opss/v2/opssRestClient/clientName
レスポンス本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
レスポンス本文には、クライアント登録属性が含まれます。登録属性の詳細は、「表2-1」を参照してください。
cURLの例
次の例は、cURLを使用してRESTリソースにGETリクエストを発行して、登録クライアントを参照する方法を示しています
curl -i -X GET -u username:password https://myhost:7001/opss/v2/opssRestClient/ myClientName
レスポンス・ヘッダーの例
次の例に、レスポンス・ヘッダーを示します。HTTPステータス・コードの詳細は、「HTTPメソッドのHTTPステータス・コード」を参照してください。
HTTP/1.1 200 OK
レスポンス本文の例
次の例に、JSON形式のレスポンス本文を示します。
{
"clientName": "myClientName",
"policystoreStripe": "CRM",
"keystore": ["appA", "appB/store1"],
"credentialMap": "mapA",
"auditComponent": "myComponent",
"trustIssueIDD" : ["cisco", "intel"],
"trustValidateIDD" : ["cisco", "intel"],
"adminGroup":"myGroup1",
"operatorGroup":"myGroup2",
"viewerGroup":"myGroup3"
}登録のPUTメソッド
登録されたクライアントの属性を更新するには、PUTメソッドを使用します。
RESTリクエスト
PUT /opss/v2/opssRestClient/clientName
リクエスト本文
リクエストまたはレスポンス本文のメディア・タイプ。
メディア・タイプ: application/json
リクエスト本文には、クライアント登録属性が含まれています。登録属性の詳細は、「表2-1」を参照してください。
cURLの例
次の例は、cURLを使用してRESTリソースにPUTリクエストを発行してクライアント属性を更新する方法を示しています
curl -i -X POST -u username:password --data @register.json -H Content-Type:application/json https://myhost:7001/opss/v2/opssRestClient/ myClientName
リクエスト本文の例
次に、JSON形式のリクエスト本文の例を示します。
{
"clientName": "myClientName",
"policystoreStripe": "CRM",
"keystore": ["appA", "appB/store1"],
"credentialMap": "mapA",
"auditComponent": "myComponent",
"trustIssueIDD" : ["cisco", "intel"],
"trustValidateIDD" : ["cisco", "intel"],
"adminGroup":"myGroup1",
"operatorGroup":"myGroup2",
"viewerGroup":"myGroup3"
}