Pular para conteúdo

Revogação de sessão de assinatura

Realiza a revogação de uma autorização concedida para sessão de assinatura.


DELETE /signature-session-authorization

Solicitação

A aplicação deve solicitar ao endpoint de revogação de sessão de assinatura do PSC SerproID, https://serproid.serpro.gov.br/oauth/v0/oauth/signature-session-authorization, informando os parâmetros necessários.

Parâmetros

HEADER:

  • Authorization - (string) - valor "Bearer <access_token>", onde <access_token> se refere ao token de acesso obtido em Token de acesso

Exemplo

O exemplo encontra-se com quebras de linha e espaços para melhor leitura

DELETE /oauth/v0/oauth/signature-session-authorization HTTP/1.1
Host: serproid.serpro.gov.br
Authorization: Bearer <token_de_acesso>
curl -X DELETE \
  https://serproid.serpro.gov.br/oauth/v0/oauth/signature-session-authorization \
  -H 'Authorization: Bearer <token_de_acesso>'

Resposta da solicitação

O PSC SerproID irá realizar a revogação da autorização concedida para a sessão de assinatura, não possibilitando que o token apresentado seja utilizado novamente em qualquer outro serviço da API.

Solicitação válida (Sucesso)

Se a solicitação estiver válida, o PSC SerproID irá retornar a solicitação com HTTP code 200.

Parâmetros

Nada será retornado no conteúdo da resposta.

Exemplo
HTTP/1.1 200 OK

Solicitação inválida (Erro)

Se a solicitação for considerada inválida, seja devido a verificação dos parâmetros informados ou caso algum erro inesperado aconteça, o PSC SerproID retornará o conteúdo da solicitação no formato application/json com o HTTP code correspondente ao tipo do erro.

Parâmetros

JSON:

  • code - (string) - código do tipo do erro
  • msg- (string) - mensagem de erro
  • debug - (string) - informações adicionais sobre o erro
Exemplo
HTTP/1.1 401 Unauthorized
Content-Type: application/json

{
    "code": "TOKEN_DE_ACESSO_INVALIDO",
    "msg": "Token de acesso não informado ou inválido",
    "debug": ""
}
Lista de erros
Tipo do erro HTTP Code Detalhes
TOKEN_DE_ACESSO_INVALIDO 401 Token de acesso não informado ou inválido
REVOGACAO_APENAS_AUTORIZACAO_SESSAO 412 Apenas autorização de sessão de assinatura é passível de revogação
AUTORIZACAO_SESSAO_JA_REVOGADA 412 A autorização de sessão se encontra revogada.
REVOKE_AUTHORIZATION_FAIL 500 Falha no processo de revogação de autorização de sessão de assinatura.