OAA管理API

すべてのエージェントを返す

get

/oaa-policy/agent/v1

リクエスト

問合せパラメータ

namefilter: string

namefilterに一致するエージェントの名前を返します。
typefilter: string

typefilterに一致するエージェントのタイプを返します。

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

application/xml
application/json

200レスポンス

エージェント情報

ルート・スキーマ: AllAgentResponse

型: object

ソースの表示

agents: array agents

フィルタに一致するすべてのエージェントの情報。
message: string

リクエストのステータスに関連するメッセージ
status: string

リクエストのステータス

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the request"
        },
        "message":{
            "type":"string",
            "description":"Message related to the status of the request"
        },
        "agents":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Agent"
            },
            "description":"Information of all agents matching the filter."
        }
    }
}

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

型: array

フィルタに一致するすべてのエージェントの情報。

ソースの表示

Array of: object schema

エージェントの詳細

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Agent"
    },
    "description":"Information of all agents matching the filter."
}

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

型: object

エージェントの詳細

ソースの表示

agentgid: string

エージェントの一意の識別子。
agentName(required): string

エージェントの一意の名前
clientId: string

エージェントの識別に使用されるエージェントのクライアントID
clientSecret: string

クライアントの認証に使用されるクライアント・シークレット
clientType(required): string

クライアント・タイプ。このフィールドで使用可能な値はOAM、RadiusまたはAPIです。
createTime: string (date-time)

"rfc3339セクション5.6の形式の日時文字列。https://tools.ietf.org/html/rfc3339#section-5.6"
description: string

エージェントの説明
privateKey: string

リクエスト・パラメータを暗号化/復号化するために使用できるエージェントの秘密キーの文字列表現。
privateKeyFile: string

秘密キーのファイル名。
privateKeyPassword: string

秘密キーのBase64でエンコードされたパスワード。
updateTime: string (date-time)

"rfc3339セクション5.6の形式の日時文字列。https://tools.ietf.org/html/rfc3339#section-5.6"

{
    "type":"object",
    "description":"Details of the agent",
    "required":[
        "agentName",
        "clientType"
    ],
    "properties":{
        "agentName":{
            "type":"string",
            "description":"Unique name of the agent"
        },
        "description":{
            "type":"string",
            "description":"Description of the agent"
        },
        "clientId":{
            "type":"string",
            "description":"Client id of the agent used to identify agents"
        },
        "clientSecret":{
            "type":"string",
            "description":"Client secret used for the authenticating client"
        },
        "clientType":{
            "type":"string",
            "description":"Client type. Possible value for this field is OAM, Radius or API."
        },
        "agentgid":{
            "type":"string",
            "description":"Unique identifier of the agent."
        },
        "privateKey":{
            "type":"string",
            "description":"String representation of the private key of the agent which can be used to encrypt/decrypt the request parameters."
        },
        "privateKeyPassword":{
            "type":"string",
            "description":"Base64 encoded password of the private key."
        },
        "privateKeyFile":{
            "type":"string",
            "description":"File name of the private key."
        },
        "createTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"Time when agent was created."
        },
        "updateTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"Time when agent was updated."
        }
    }
}

401レスポンス

未認可

405レスポンス

無効な入力

ルート・スキーマ: AllAgentResponse

型: object

ソースの表示

agents: array agents

フィルタに一致するすべてのエージェントの情報。
message: string

リクエストのステータスに関連するメッセージ
status: string

リクエストのステータス

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the request"
        },
        "message":{
            "type":"string",
            "description":"Message related to the status of the request"
        },
        "agents":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Agent"
            },
            "description":"Information of all agents matching the filter."
        }
    }
}

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

型: array

フィルタに一致するすべてのエージェントの情報。

ソースの表示

Array of: object schema

エージェントの詳細

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Agent"
    },
    "description":"Information of all agents matching the filter."
}

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

型: object

エージェントの詳細

ソースの表示

agentgid: string

エージェントの一意の識別子。
agentName(required): string

エージェントの一意の名前
clientId: string

エージェントの識別に使用されるエージェントのクライアントID
clientSecret: string

クライアントの認証に使用されるクライアント・シークレット
clientType(required): string

クライアント・タイプ。このフィールドで使用可能な値はOAM、RadiusまたはAPIです。
createTime: string (date-time)

"rfc3339セクション5.6の形式の日時文字列。https://tools.ietf.org/html/rfc3339#section-5.6"
description: string

エージェントの説明
privateKey: string

リクエスト・パラメータを暗号化/復号化するために使用できるエージェントの秘密キーの文字列表現。
privateKeyFile: string

秘密キーのファイル名。
privateKeyPassword: string

秘密キーのBase64でエンコードされたパスワード。
updateTime: string (date-time)

"rfc3339セクション5.6の形式の日時文字列。https://tools.ietf.org/html/rfc3339#section-5.6"

{
    "type":"object",
    "description":"Details of the agent",
    "required":[
        "agentName",
        "clientType"
    ],
    "properties":{
        "agentName":{
            "type":"string",
            "description":"Unique name of the agent"
        },
        "description":{
            "type":"string",
            "description":"Description of the agent"
        },
        "clientId":{
            "type":"string",
            "description":"Client id of the agent used to identify agents"
        },
        "clientSecret":{
            "type":"string",
            "description":"Client secret used for the authenticating client"
        },
        "clientType":{
            "type":"string",
            "description":"Client type. Possible value for this field is OAM, Radius or API."
        },
        "agentgid":{
            "type":"string",
            "description":"Unique identifier of the agent."
        },
        "privateKey":{
            "type":"string",
            "description":"String representation of the private key of the agent which can be used to encrypt/decrypt the request parameters."
        },
        "privateKeyPassword":{
            "type":"string",
            "description":"Base64 encoded password of the private key."
        },
        "privateKeyFile":{
            "type":"string",
            "description":"File name of the private key."
        },
        "createTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"Time when agent was created."
        },
        "updateTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"Time when agent was updated."
        }
    }
}

500レスポンス

内部サーバー・エラー

503レスポンス

サービス使用不可

先頭に戻る

例

次の例は、ストアからすべてのエージェントを取得するサンプルのリクエストとレスポンスを示しています。

JSON形式でストアからすべてのエージェントを取得するcURLコマンド

curl --location --request GET '<PolicyUrl>/oaa-policy/agent/v1' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

JSON形式のサンプル・レスポンス

{
    "status": "200",
    "message": "Successful",
    "agents": [
        {
            "agentName": "APIAgent",
            "description": "Agent for REST API",
            "clientId": "c1e08e6a-b555-47e1-84a5-36edd06fbf57",
            "clientSecret": "b2484989-5f42-4ad8-b0ab-7bbaa06ee786",
            "clientType": "api",
            "agentgid": "dede64d3-1d6a-42e9-89e1-714e88f8967c",
            "createTime": {
                "parseFailed": false,
                "dateTime": "2021-04-01T09:06:13.668Z",
                "rawParam": "2021-04-01T09:06:13.668Z"
            },
            "updateTime": {
                "parseFailed": false,
                "dateTime": "2021-04-01T09:06:13.668Z",
                "rawParam": "2021-04-01T09:06:13.668Z"
            }
        },
        {
            "agentName": "RadiusAgent",
            "description": "Radius Agent",
            "clientId": "3d3f3800-e801-4e26-9930-1f5a9021eb38",
            "clientSecret": "0ef31e1f-4123-40bc-8df7-79810116af54",
            "clientType": "radius",
            "agentgid": "e53bc397-b17b-4765-822c-e1e7f24ac14f",
            "createTime": {
                "parseFailed": false,
                "dateTime": "2021-04-01T09:14:34.833Z",
                "rawParam": "2021-04-01T09:14:34.833Z"
            },
            "updateTime": {
                "parseFailed": false,
                "dateTime": "2021-04-01T09:14:34.833Z",
                "rawParam": "2021-04-01T09:14:34.833Z"
            }
        },
        {
            "agentName": "OAM-MFAPartner",
            "description": "OAA TAP Partner",
            "clientId": "12e80604-1ae4-43d9-8839-170ae5534274",
            "clientSecret": "ce8cb5d5-642b-4338-a267-19feb344fbfd",
            "clientType": "oam",
            "agentgid": "58a4bc7f-073b-4fca-9eee-ed0882e4d293",
            "privateKey": "CECECECE000000020000000100000003000C7461706369706865726B657900000177916E17A2ACED000573720033636F6D2E73756E2E63727970746F2E70726F76696465722E5365616C65644F626A656374466F724B657950726F746563746F72CD57CA59E730BB53020000787200196A617661782E63727970746F2E5365616C65644F626A6563743E363DA6C3B754700200045B000D656E636F646564506172616D737400025B425B0010656E63727970746564436F6E74656E7471007E00024C0009706172616D73416C677400124C6A6176612F6C616E672F537472696E673B4C00077365616C416C6771007E00037870757200025B42ACF317F8060854E0020000787000000011300F04085F3CED99EE429B350203030D407571007E00050000009069A8587D9C6671DFEC9A48E18A45BBC106F8518EBB1AC2A7B94CC779C5AD0D3F52863FE6D13E02EFFB60EDDB47FB229D5CD0A6E2312A9467F88F355AE504DDA4C632CA9CB6CBCE7A9C001FD7B7F7FD5505221FBC39968E262B717094E940D817EEBAB14F38865CFCBB12BA0CD8DDB06DA738F6776111DDDBE8ECD25EE59A274CCAFE06BBBB5535E8DAD9648C08EDA6AA740016504245576974684D4435416E64547269706C65444553740016504245576974684D4435416E64547269706C654445531A355132C5E0EBBEF4022030F940DC8495DEA491",
            "privateKeyPassword": "<password>",
            "privateKeyFile": "OAMOAAKeyStore.jks",
            "createTime": {
                "parseFailed": false,
                "dateTime": "2021-04-01T09:13:13.391Z",
                "rawParam": "2021-04-01T09:13:13.391Z"
            },
            "updateTime": {
                "parseFailed": false,
                "dateTime": "2021-04-01T09:13:13.392Z",
                "rawParam": "2021-04-01T09:13:13.392Z"
            }
        }
    ]
}

XML形式でストアからすべてのエージェントを取得するcURLコマンド

curl --location --request GET '<PolicyUrl>/oaa-policy/agent/v1' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

XML形式のサンプル・レスポンス

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AgentResponse>
     <status>200</status>
     <message>Successful</message>
     <agents>
         <agentName>APIAgent</agentName>
         <description>Agent for REST API</description>
         <clientId>c1e08e6a-b555-47e1-84a5-36edd06fbf57</clientId>
         <clientSecret>b2484989-5f42-4ad8-b0ab-7bbaa06ee786</clientSecret>
         <clientType>api</clientType>
         <agentgid>dede64d3-1d6a-42e9-89e1-714e88f8967c</agentgid>
         <createTime>
             <parseFailed>false</parseFailed>
             <dateTime>2021-04-01T09:06:13.668Z</dateTime>
             <rawParam>2021-04-01T09:06:13.668Z</rawParam>
         </createTime>
         <updateTime>
             <parseFailed>false</parseFailed>
             <dateTime>2021-04-01T09:06:13.668Z</dateTime>
             <rawParam>2021-04-01T09:06:13.668Z</rawParam>
         </updateTime>
     </agents>
     <agents>
         <agentName>RadiusAgent</agentName>
         <description>Radius Agent</description>
         <clientId>3d3f3800-e801-4e26-9930-1f5a9021eb38</clientId>
         <clientSecret>0ef31e1f-4123-40bc-8df7-79810116af54</clientSecret>
         <clientType>radius</clientType>
         <agentgid>e53bc397-b17b-4765-822c-e1e7f24ac14f</agentgid>
         <createTime>
             <parseFailed>false</parseFailed>
             <dateTime>2021-04-01T09:14:34.833Z</dateTime>
             <rawParam>2021-04-01T09:14:34.833Z</rawParam>
         </createTime>
         <updateTime>
             <parseFailed>false</parseFailed>
             <dateTime>2021-04-01T09:14:34.833Z</dateTime>
             <rawParam>2021-04-01T09:14:34.833Z</rawParam>
         </updateTime>
     </agents>
     <agents>
         <agentName>OAM-MFAPartner</agentName>
         <description>OAA TAP Partner</description>
         <clientId>12e80604-1ae4-43d9-8839-170ae5534274</clientId>
         <clientSecret>ce8cb5d5-642b-4338-a267-19feb344fbfd</clientSecret>
         <clientType>oam</clientType>
         <agentgid>58a4bc7f-073b-4fca-9eee-ed0882e4d293</agentgid>
         <privateKey>CECECECE000000020000000100000003000C7461706369706865726B657900000177916E17A2ACED000573720033636F6D2E73756E2E63727970746F2E70726F76696465722E5365616C65644F626A656374466F724B657950726F746563746F72CD57CA59E730BB53020000787200196A617661782E63727970746F2E5365616C65644F626A6563743E363DA6C3B754700200045B000D656E636F646564506172616D737400025B425B0010656E63727970746564436F6E74656E7471007E00024C0009706172616D73416C677400124C6A6176612F6C616E672F537472696E673B4C00077365616C416C6771007E00037870757200025B42ACF317F8060854E0020000787000000011300F04085F3CED99EE429B350203030D407571007E00050000009069A8587D9C6671DFEC9A48E18A45BBC106F8518EBB1AC2A7B94CC779C5AD0D3F52863FE6D13E02EFFB60EDDB47FB229D5CD0A6E2312A9467F88F355AE504DDA4C632CA9CB6CBCE7A9C001FD7B7F7FD5505221FBC39968E262B717094E940D817EEBAB14F38865CFCBB12BA0CD8DDB06DA738F6776111DDDBE8ECD25EE59A274CCAFE06BBBB5535E8DAD9648C08EDA6AA740016504245576974684D4435416E64547269706C65444553740016504245576974684D4435416E64547269706C654445531A355132C5E0EBBEF4022030F940DC8495DEA491</privateKey>
         <privateKeyPassword>
             <password></privateKeyPassword>
             <privateKeyFile>OAMOAAKeyStore.jks</privateKeyFile>
             <createTime>
                 <parseFailed>false</parseFailed>
                 <dateTime>2021-04-01T09:13:13.391Z</dateTime>
                 <rawParam>2021-04-01T09:13:13.391Z</rawParam>
             </createTime>
             <updateTime>
                 <parseFailed>false</parseFailed>
                 <dateTime>2021-04-01T09:13:13.392Z</dateTime>
                 <rawParam>2021-04-01T09:13:13.392Z</rawParam>
             </updateTime>
         </agents>
</AgentResponse>

先頭に戻る