Skip to content
Orillion logo
Soramitsu logo

Logging a user out of the system

Signs out the authorized FIB user from the FIB API server.

Protocol: HTTP

EncodingJSON

Endpoint/auth/api/v1/authentication-management/logout

MethodPOST

Header: Authorization — represented by a string that is the accessToken value that was returned either at the authorization, or the previous time the token has been refreshed.

Input/request structure

A POST request to the endpoint with the Authorization header specified.

Output/response structure

Show
json5
{
  status: {
    code: integer($int32),
    name: 'string'
  },
  data: {}
}
{
  status: {
    code: integer($int32),
    name: 'string'
  },
  data: {}
}
json5
{
  status: {
    code: 200,
    name: 'OK'
  },
  data: {}
}
{
  status: {
    code: 200,
    name: 'OK'
  },
  data: {}
}

Responses

Response CodeDescription
200User has been successfully logged out.
400Bad request.
401Either user signature or refreshToken are not valid, or the accessToken bearer token could not be parsed from the Authorization header.
404User has not been found.
422User signature either could not be decoded or verified, or the publicKey string is not valid.
500Internal server error.