Jump to

• Request
• Response

Updates RADIUS Client Using Host

patch

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

Permits administrator to update properties of a registered RADIUS client other than the shared secret using host name or IP address.

Request

Path Parameters

• hostName(required): string
  IP address or host name of the registered RADIUS client

Supported Media Types

• application/json

Request Body - application/json ()

Properties to update

Root Schema : schema

Type: object

Show Source

• applicationName(required): string
  Name of the RADIUS client application

  Example: Database RADIUS Client
• applicationType: string
  Type of the RADIUS client application

  Example: Oracle, Cisco VPN, SSH etc.
• description: string
  Description of the RADIUS client application

  Example: Database RADIUS client for DB Authentication
• hostName(required): string
  RADIUS client host name or IP address

  Example: Add IP address or hostname of RADIUS client machine here
• id(required): integer (int64)
  Read Only: true

  Id generated for the RADIUS client
• sharedSecret(required): string
  Read Only: true

  Shared secret generated during registration of RADIUS client

{
    "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"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

RADIUS client properties updated successfully.

Body ()

Root Schema : schema

Type: object

Show Source

• applicationName(required): string
  Name of the RADIUS client application

  Example: Database RADIUS Client
• applicationType: string
  Type of the RADIUS client application

  Example: Oracle, Cisco VPN, SSH etc.
• description: string
  Description of the RADIUS client application

  Example: Database RADIUS client for DB Authentication
• hostName(required): string
  RADIUS client host name or IP address

  Example: Add IP address or hostname of RADIUS client machine here
• id(required): integer (int64)
  Read Only: true

  Id generated for the RADIUS client
• sharedSecret(required): string
  Read Only: true

  Shared secret generated during registration of RADIUS client

{
    "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 Response

Error occurred during updating the details of the given RADIUS client.

Body ()

Root Schema : ResponseMessage

Type: object

Show Source

• details: string
  Details about the error occurred

  Example: Detailed message about the cause of the error.
• errorCode: string
  The error code of the error occurred

  Example: IRA-00001
• message: string
  Message of the success/error

  Example: Configuration is successfully updated.
• timestamp: string (date)
  Timestamp at which success/error occurred

  Example: 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 Response

The given RADIUS client not registered with Oracle RADIUS Agent.

Body ()

Root Schema : ResponseMessage

Type: object

Show Source

• details: string
  Details about the error occurred

  Example: Detailed message about the cause of the error.
• errorCode: string
  The error code of the error occurred

  Example: IRA-00001
• message: string
  Message of the success/error

  Example: Configuration is successfully updated.
• timestamp: string (date)
  Timestamp at which success/error occurred

  Example: 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 Response

RADIUS client already exists with given host name/IP address or client name.

Body ()

Root Schema : ResponseMessage

Type: object

Show Source

• details: string
  Details about the error occurred

  Example: Detailed message about the cause of the error.
• errorCode: string
  The error code of the error occurred

  Example: IRA-00001
• message: string
  Message of the success/error

  Example: Configuration is successfully updated.
• timestamp: string (date)
  Timestamp at which success/error occurred

  Example: 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"
}

Back to Top