ジャンプ先

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

エージェントを作成する

post

/oaa-policy/agent/v1

リクエスト

この操作にはリクエスト・パラメータはありません。

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

• application/xml
• application/json

リクエスト本文 - application/xml ()

ルート・スキーマ : 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."
        }
    }
}

リクエスト本文 - application/json ()

ルート・スキーマ : 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."
        }
    }
}

先頭に戻る

レスポンス

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

• application/xml
• application/json

201レスポンス

エージェントが作成されました

本文()

ルート・スキーマ: AgentResponse

型: object

ソースの表示

• agent: object schema
  エージェントの詳細
• agentgid: string
  後続のリクエストで使用できるエージェントのグローバル識別子。
• 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"
        },
        "agentgid":{
            "type":"string",
            "description":"Global identifier of the agent which can be used in the subsequent request."
        },
        "agent":{
            "description":"Original request object which was used for creating the agent",
            "$ref":"#/components/schemas/Agent"
        }
    }
}

ネストされたスキーマ: 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レスポンス

無効な入力

本文()

ルート・スキーマ: AgentResponse

型: object

ソースの表示

• agent: object schema
  エージェントの詳細
• agentgid: string
  後続のリクエストで使用できるエージェントのグローバル識別子。
• 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"
        },
        "agentgid":{
            "type":"string",
            "description":"Global identifier of the agent which can be used in the subsequent request."
        },
        "agent":{
            "description":"Original request object which was used for creating the agent",
            "$ref":"#/components/schemas/Agent"
        }
    }
}

ネストされたスキーマ: 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 POST '<PolicyUrl>/oaa-policy/agent/v1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
    "agentName": "APIAgent",
    "description": "Agent for REST API",
    "clientType": "API"
}'

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

{
    "status": "201",
    "message": "Successfully created agent.",
    "agentgid": "dede64d3-1d6a-42e9-89e1-714e88f8967c",
    "agent": {
        "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"
        }
    }
}

XML形式でエージェントを作成するcURLコマンド

curl --location --request POST '<PolicyUrl>/oaa-policy/agent/v1' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '<?xml version="1.0" encoding="UTF-8" ?>
<Agent>
     <agentName>APIAgent</agentName>
     <description>Agent for REST API</description>
     <clientType>API</clientType>
</Agent>'

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <AgentResponse>
     <status>201</status>
     <message>Successfully created agent.</message>
     <agentgid>dede64d3-1d6a-42e9-89e1-714e88f8967c</agentgid>
     <agent>
         <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>
     </agent>
 </AgentResponse>

先頭に戻る