Jump to

• Request
• Response

Creates VSA

post

/radius-config/v1/vsa

Permits administrators to create vendor specific attributes.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

New vendor specific attribute details to be created

Root Schema : schema

Type: object

Show Source

• attributeId(required): integer (int32)
  Attribute id for the VSA

  Example: 1
• attributeName(required): string
  Name of the VSA

  Example: Oracle_Role
• attributeType(required): string
  Attribute type for the VSA

  Example: string, octets, ipaddr, integer etc.
• vendorId(required): integer (int32)
  Vendor ID associated with the given VSA

  Example: 111
• vendorName: string
  Vendor Name

  Example: CompanyX

{
    "required":[
        "attributeId",
        "attributeName",
        "attributeType",
        "vendorId"
    ],
    "properties":{
        "attributeId":{
            "description":"Attribute id for the VSA",
            "example":"1",
            "format":"int32",
            "type":"integer"
        },
        "attributeName":{
            "description":"Name of the VSA",
            "example":"Oracle_Role",
            "type":"string"
        },
        "attributeType":{
            "description":"Attribute type for the VSA",
            "example":"string, octets, ipaddr, integer etc.",
            "type":"string"
        },
        "vendorId":{
            "description":"Vendor ID associated with the given VSA",
            "example":"111",
            "format":"int32",
            "type":"integer"
        },
        "vendorName":{
            "description":"Vendor Name",
            "example":"CompanyX",
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Vendor specific attribute created successfully.

400 Response

Bad request

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

Vendor specific attribute already present in 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"
}

Back to Top