signOut

POST

/sign-out

curl --request POST \
  --url https://gymgym.club/api/auth/sign-out \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "callbackURL": "example", "disableRedirect": true, "state": "example" }'

Sign out the current user

Authorizations

• bearerAuth

Request Body

Media typeapplication/json

object

callbackURL

The URL to redirect to after provider logout

string

disableRedirect

Return the provider logout URL without redirecting

boolean

state

State to pass to the provider logout endpoint

string

Example^generated

{
  "callbackURL": "example",
  "disableRedirect": true,
  "state": "example"
}

Responses

200

Success

Media typeapplication/json

object

success

boolean

url

Provider logout URL when RP-initiated logout is available

string

redirect

Whether the client should redirect to the provider logout URL

boolean

Example^generated

{
  "success": true,
  "url": "example",
  "redirect": true
}

400

Bad Request. Usually due to missing parameters, or invalid parameters.

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

401

Unauthorized. Due to missing or invalid authentication.

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

403

Forbidden. You do not have permission to access this resource or to perform this action.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

404

Not Found. The requested resource was not found.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

429

Too Many Requests. You have exceeded the rate limit. Try again later.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

500

Internal Server Error. This is a problem with the server that you cannot fix.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}