Jump to

• Request
• Response

Delete an Authentication Type Instance

delete

/api/AAA/AuthTypes/{id}

Deletes the authentication type instance that matches the specified ID. You cannot delete authentication type instances that have associated users. First you must remove the users or update them to use a different authentication type instance. You can never delete the default internal authentication type (ID: 1).

Request

Path Parameters

• id(required): integer(int32)
  The ID of the authentication type instance to delete.

  Example:

  5

There's no request body for this operation.

Back to Top

Response

200 Response

Successful operation

Body ()

Root Schema : SuccessfulDeleteOperation

Type: object

The response body for a successful delete operation.

Show Source

• message: string
  The response message.

  Example: Deleted record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful delete operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Deleted record"
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top