Delete Session for Tenant ID (v2.0)

DELETE 
/v2.0/api/tenants/:tenant_id/operators/:operator_id/sessions/:session_id

Delete the session for a tenant ID, operator ID, and session ID.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

operator_id stringrequired

The operator ID.

session_id stringrequired

The session ID.

Responses

200

Successful Operation

application/json

Schema

Schema

client_ip string

The client IP address.

disabled boolean

List the disabled sessions for an operator ID.

disabled_reason string

The reason for disabling the sessions.

expires date

The expiry date of the session.

id string

The ID.

inactive boolean

List the inactive sessions.

inactive_reason string

The reason for the inactive sessions.

operator_id string

The operator ID.

session_key_c string

The session key C. Max size = 128.

tenant_id stringrequired

ID of the tenant.

type string

The session type.

user_agent UserAgent

The user agent information.

name string

The name of the user agent.

Example (from schema)

{
  "client_ip": "string",
  "disabled": true,
  "disabled_reason": "string",
  "expires": "2024-07-29",
  "id": "string",
  "inactive": true,
  "inactive_reason": "string",
  "operator_id": "string",
  "session_key_c": "string",
  "tenant_id": "string",
  "type": "string",
  "user_agent": {
    "name": "string"
  }
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "OPERATOR_INVALID_SUBJECT_DATA"
      }
    ]
  }
}

Loading...