API Related User

Você pode gerenciar usuários relacionados no PAM Core através dos métodos WebService A2A.

Requirements

Para solicitar a API de usuários relacionados, você deve ter o seguinte:

• Opção "Usuários" habilitada em "Recursos autorizados" nas configurações de segurança de autorização do aplicativo A2A registrado.

Listar todos

A tabela abaixo contém os parâmetros de entrada necessários e exemplos:

Este método lista todos os usuários relacionados.

GET /iso/user/related

Resposta esperada

HTTP/1.1 200 OK 

{
    "response": {
        "status": 200,
        "mensagem": "2 related users found",
        "erro": false,
        "cod_erro": 0,
        "message": "2 related users found",
        "error": false,
        "error_code": 0
    },
    "relatedUsers": [
   	{          
        "id": 1,
        "name":  "Ashley Perry",
        "username": "aperry"
      },
      {
        "id": 2,
        "name": "John Green",
        "username": "jgreen"
      }
   ]
}

Obter um usuário relacionado

Este método retorna informações sobre um usuário relacionado específico, identificado por sua ID.

GET /iso/user/related/{identifier}

Resposta esperada

HTTP/1.1 200 OK 

{
    "response": {
        "status": 200,
        "mensagem": "User found",
        "erro": false,
        "cod_erro": 0,
        "message": "User found",
        "error": false,
        "error_code": 0
    },
    "relatedUsers": 
   	{          
        "id": 1,
        "name": "Ashley",
        "username": "aperry"
      }
}

Resposta esperada quando o usuário relacionado não é encontrado

HTTP/1.1 400 Bad Request

{
    "response": {
        "status": 400,
        "mensagem": "1005: User does not exist",
        "erro": true,
        "cod_erro": 0,
        "message": "1005: User does not exist",
        "error": true,
        "error_code": 0
    },
    "exception": {
        "code": 1005,
        "message": "1005: User does not exist",
        "detail": ""
    }

}

Inativar um usuário relacionado

Este método inativa um usuário relacionado identificado por seu ID.

DELETE /iso/user/related/{identifier}

Resposta esperada

HTTP/1.1 200 OK 

{
    "response": {
        "status": 200,
        "mensagem": "Related user successfully deactivated",
        "erro": false,
        "message": "Related user successfully deactivated",
        "error": false,
    }
}

Resposta esperada quando o usuário relacionado não é encontrado

HTTP/1.1 400 Bad Request

{
    "response": {
        "status": 400,
        "mensagem": "1005: Related user not found",
        "erro": true,
        "cod_erro": 0,
        "message": "1005: Related user not found",
        "error": true,
        "error_code": 0
    },
    "exception": {
        "code": 1005,
        "message": "1005: Related user not found",
        "detail": ""
    }

}

Criar um usuário relacionado

Este método criar um novo usuário relacionado.

POST /iso/user/related

Exemplo de solicitação

{ 
    "name": "Ashley Perry",
    "username": "aperry"
}

Resposta esperada

HTTP/1.1 200 OK 

{
    "response": {
        "status": 200,
        "mensagem": "Related user successfully registered!",
        "erro": false,
        "message": "Related user successfully registered!",
        "error": false,
    },
    "relatedUsers": {          
        "id": 3,
        "name": "Ashley Perry",
        "username": "aperry"
      }
}

Resposta esperada ao cadastrar sem as informações necessárias

HTTP/1.1 400 Bad Request

{
    "response": {
        "status": 400,
        "mensagem": "1001: Parameter 'username' was not informed!",
        "erro": true,
        "cod_erro": 0,
        "message": "1001: Parameter 'username' was not informed!",
        "error": true,
        "error_code": 0
    },
    "exception": {
        "code": 1001,
        "message": "1001: Parameter 'username' was not informed!",
        "detail": ""
    }

}

Atualizar um usuário relacionado

Este método atualiza um usuário relacionado identificado por seu ID.

PUT /iso/user/related

Resposta esperada

{ 
    "id" : 15,
    "name": "Test name",
    "username": "test"
}

Resposta esperada

"response": {
        "status": 200,
        "mensagem": "Related user successfully updated!",
        "erro": false,
        "cod_erro": 0,
        "message": "Related user successfully updated!",
        "error": false,
        "error_code": 0
    },
    "relatedUsers": {
        "id": "15",
        "name": "Test Update",
        "username": "test"
    }