ジャンプ先

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

ホストを使用したRADIUSクライアントの更新

patch

/radius-admin/v1/clients/{hostName}

管理者は、ホスト名またはIPアドレスを使用して、共有シークレット以外の登録済RADIUSクライアントのプロパティを更新できます。

リクエスト

パス・パラメータ

• hostName(必須): string
  登録済RADIUSクライアントのIPアドレスまたはホスト名

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

• application/json

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

更新するプロパティ

ルート・スキーマ: schema

型: object

ソースを表示

• applicationName(必須): string
  RADIUSクライアント・アプリケーションの名前

  例: Database RADIUS Client
• applicationType: string
  RADIUSクライアント・アプリケーションのタイプ

  例: Oracle、Cisco VPN、SSHなど
• description: string
  RADIUSクライアント・アプリケーションの説明

  例: Database RADIUS client for DB Authentication
• hostName(必須): string
  RADIUSクライアントのホスト名またはIPアドレス

  例: Add IP address or hostname of RADIUS client machine here
• id(必須): integer (int64)
  読取り専用: true

  RADIUSクライアントに対して生成されたID
• sharedSecret(必須): string
  読取り専用: true

  RADIUSクライアントの登録中に生成された共有シークレット

{
    "required":[
        "applicationName",
        "hostName",
        "id",
        "sharedSecret"
    ],
    "properties":{
        "applicationName":{
            "description":"Name of the RADIUS client application",
            "example":"Database RADIUS Client",
            "type":"string"
        },
        "applicationType":{
            "description":"Type of the RADIUS client application",
            "example":"Oracle, Cisco VPN, SSH etc.",
            "nullable":true,
            "type":"string"
        },
        "description":{
            "description":"Description of the RADIUS client application",
            "example":"Database RADIUS client for DB Authentication",
            "nullable":true,
            "type":"string"
        },
        "hostName":{
            "description":"RADIUS client host name or IP address",
            "example":"Add IP address or hostname of RADIUS client machine here",
            "type":"string"
        },
        "id":{
            "description":"Id generated for the RADIUS client",
            "format":"int64",
            "readOnly":true,
            "type":"integer"
        },
        "sharedSecret":{
            "description":"Shared secret generated during registration of RADIUS client",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

RADIUSクライアント・プロパティは正常に更新されました。

本文()

ルート・スキーマ: schema

型: object

ソースを表示

• applicationName(必須): string
  RADIUSクライアント・アプリケーションの名前

  例: Database RADIUS Client
• applicationType: string
  RADIUSクライアント・アプリケーションのタイプ

  例: Oracle、Cisco VPN、SSHなど
• description: string
  RADIUSクライアント・アプリケーションの説明

  例: Database RADIUS client for DB Authentication
• hostName(必須): string
  RADIUSクライアントのホスト名またはIPアドレス

  例: Add IP address or hostname of RADIUS client machine here
• id(必須): integer (int64)
  読取り専用: true

  RADIUSクライアントに対して生成されたID
• sharedSecret(必須): string
  読取り専用: true

  RADIUSクライアントの登録中に生成された共有シークレット

{
    "required":[
        "applicationName",
        "hostName",
        "id",
        "sharedSecret"
    ],
    "properties":{
        "applicationName":{
            "description":"Name of the RADIUS client application",
            "example":"Database RADIUS Client",
            "type":"string"
        },
        "applicationType":{
            "description":"Type of the RADIUS client application",
            "example":"Oracle, Cisco VPN, SSH etc.",
            "nullable":true,
            "type":"string"
        },
        "description":{
            "description":"Description of the RADIUS client application",
            "example":"Database RADIUS client for DB Authentication",
            "nullable":true,
            "type":"string"
        },
        "hostName":{
            "description":"RADIUS client host name or IP address",
            "example":"Add IP address or hostname of RADIUS client machine here",
            "type":"string"
        },
        "id":{
            "description":"Id generated for the RADIUS client",
            "format":"int64",
            "readOnly":true,
            "type":"integer"
        },
        "sharedSecret":{
            "description":"Shared secret generated during registration of RADIUS client",
            "readOnly":true,
            "type":"string"
        }
    },
    "type":"object"
}

400レスポンス

指定されたRADIUSクライアントの詳細の更新中にエラーが発生しました。

本文()

ルート・スキーマ: ResponseMessage

型: object

ソースを表示

• details: string
  発生したエラーの詳細

  例: エラーの原因に関する詳細なメッセージ。
• errorCode: string
  発生したエラーのエラー・コード

  例: IRA-00001
• message: string
  成功/エラーのメッセージ

  例: 構成は正常に更新されました。
• timestamp: string (date)
  成功/エラーが発生したタイムスタンプ

  例: 2021-03-01T15:08:40.933Z[UTC]

{
    "properties":{
        "timestamp":{
            "description":"Timestamp at which success/error occurred",
            "example":"2021-03-01T15:08:40.933Z[UTC]",
            "format":"date",
            "type":"string"
        },
        "errorCode":{
            "description":"The error code of the error occurred",
            "example":"IRA-00001",
            "type":"string"
        },
        "message":{
            "description":"Message of the success/error",
            "example":"Configuration  is successfully updated.",
            "type":"string"
        },
        "details":{
            "description":"Details about the error occurred",
            "example":"Detailed message about the cause of the error.",
            "type":"string"
        }
    },
    "type":"object"
}

404レスポンス

指定されたRADIUSクライアントはOracle RADIUS Agentに登録されていません。

本文()

ルート・スキーマ: ResponseMessage

型: object

ソースを表示

• details: string
  発生したエラーの詳細

  例: エラーの原因に関する詳細なメッセージ。
• errorCode: string
  発生したエラーのエラー・コード

  例: IRA-00001
• message: string
  成功/エラーのメッセージ

  例: 構成は正常に更新されました。
• timestamp: string (date)
  成功/エラーが発生したタイムスタンプ

  例: 2021-03-01T15:08:40.933Z[UTC]

{
    "properties":{
        "timestamp":{
            "description":"Timestamp at which success/error occurred",
            "example":"2021-03-01T15:08:40.933Z[UTC]",
            "format":"date",
            "type":"string"
        },
        "errorCode":{
            "description":"The error code of the error occurred",
            "example":"IRA-00001",
            "type":"string"
        },
        "message":{
            "description":"Message of the success/error",
            "example":"Configuration  is successfully updated.",
            "type":"string"
        },
        "details":{
            "description":"Details about the error occurred",
            "example":"Detailed message about the cause of the error.",
            "type":"string"
        }
    },
    "type":"object"
}

409レスポンス

指定されたホスト名/IPアドレスまたはクライアント名のRADIUSクライアントはすでに存在します。

本文()

ルート・スキーマ: ResponseMessage

型: object

ソースを表示

• details: string
  発生したエラーの詳細

  例: エラーの原因に関する詳細なメッセージ。
• errorCode: string
  発生したエラーのエラー・コード

  例: IRA-00001
• message: string
  成功/エラーのメッセージ

  例: 構成は正常に更新されました。
• timestamp: string (date)
  成功/エラーが発生したタイムスタンプ

  例: 2021-03-01T15:08:40.933Z[UTC]

{
    "properties":{
        "timestamp":{
            "description":"Timestamp at which success/error occurred",
            "example":"2021-03-01T15:08:40.933Z[UTC]",
            "format":"date",
            "type":"string"
        },
        "errorCode":{
            "description":"The error code of the error occurred",
            "example":"IRA-00001",
            "type":"string"
        },
        "message":{
            "description":"Message of the success/error",
            "example":"Configuration  is successfully updated.",
            "type":"string"
        },
        "details":{
            "description":"Details about the error occurred",
            "example":"Detailed message about the cause of the error.",
            "type":"string"
        }
    },
    "type":"object"
}

先頭に戻る