Invalidate linked web session

POST 
/invalidate_linked_web_session

This endpoint allows you to invalidate the web session which is associated with your authenticated identity. This will only work for API identities (most likely API tokens) that were generated using the first-party application login flow.

Request

application/json

Body

object

Responses

200

This endpoint allows you to invalidate the web session which is associated with your authenticated identity. This will only work for API identities (most likely API tokens) that were generated using the first-party application login flow.

application/json

Schema

Schema

status booleanrequired

Example (from schema)

{
  "status": true
}

400

400 error response

application/json

Schema

Schema

oneOf

APIAuthenticator400Schema

No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer

code MissingAPITokenEnum (string)

Possible values: [missing_api_token]

description string

detail object

IdentityNotLinkedToWebSessionSchema

The authenticated identity is not linked to a web session

code IdentityNotLinkedToWebSessionEnum (string)

Possible values: [identity_not_linked_to_web_session]

description string

detail object

Example (from schema)

{}

403

403 error response

application/json

Schema

Schema

oneOf

UnauthorizedNetworkForAPITokenSchema

Network is not allowed to access the API with this API token

code UnauthorizedNetworkForAPITokenEnum (string)

Possible values: [unauthorized_network_for_api_token]

description string

detail

object

ip_address string

The IP address the request was received from

InvalidAPITokenSchema

The API token provided was not valid (it may not exist or have expired)

code InvalidAPITokenEnum (string)

Possible values: [invalid_api_token]

description string

detail

object

details stringnullable

InvalidCapabilitiesTokenSchema

The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)

code InvalidCapabilitiesTokenEnum (string)

Possible values: [invalid_capabilities_token]

description string

detail object

ScopeNotGrantedErrorSchema

The scope required for this endpoint has not been granted to the authenticating identity

code ScopeNotGrantedErrorEnum (string)

Possible values: [scope_not_granted]

description string

detail

ScopeNotGrantedError

scopes string[]

Example (from schema)

{}

429

You have reached the rate limit for this type of request

application/json

Schema

Schema

code RateLimitReachedEnum (string)

Possible values: [rate_limit_reached]

description string

detail

object

total_permitted integer

The total number of requests per minute that are permitted

Example (from schema)

{
  "code": "rate_limit_reached",
  "description": "string",
  "detail": {
    "total_permitted": 0
  }
}

503

The service is currently unavailable, please try again later

application/json

Schema

Schema

code ServiceUnavailableEnum (string)

Possible values: [service_unavailable]

description string
detail object

Example (from schema)

{
  "code": "service_unavailable",
  "description": "string",
  "detail": {}
}

Loading...