Create or update a related user

This document presents how to create or update, via API, related users’ information registered in senhasegura, the available endpoints, the parameters needed, example requests, and responses on success or in case of errors.

Authorization

To get started, make sure Users is listed under Authorized resources in your A2A module. For more information on authorization, access the How to create an authorization for an application document.

Authentication

Each request in the API must have the OAuth Consumer Key and the OAuth Token of the client.
For more information on authentication, access the How to authenticate an application document.

Methods

Create a related user

Request

To create a related user in senhasegura, send a request to the following endpoint:

POST /iso/user/related

Request parameters

Body

Example request

{ 
    "name": "ademirdiniz",
    "username": "adiniz"
}

Return

Creates a related user in senhasegura and returns a message with information about the creation process.

Expected response

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": "ademirdiniz",
        "username": "adiniz"
      }
}

In case of error - missing a required parameter

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": ""
    }

Update a related user

Request

To update a related user registered in senhasegura, send a request to the following endpoint:

PUT /iso/user/related/id

Request parameters

Path

Body

Example request

{ 
    "id" : 3,
    "name": "Ademir Diniz",
    "username": "addiniz"
}

Return

Updates a related user registered in senhasegura based on its id and returns a message with information about the updating process.

Expected response

HTTP/1.1 200 OK

"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": "3",
        "name": "Ademir Diniz",
        "username": "aadiniz"
    }

In case of error - missing a required parameter

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": ""
    }
}

In case of error - user not found

HTTP/1.1 400 Bad Request

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