Users

Endpoints to work with the users of a partner.

Get users

GET /api/internal/v1/partners/:partner_id/users

Get the users of the given partner. The users are paginated and can be optionally searched by giving the search query parameter. The action must be performed by an authenticated user with permission users.read and partner access.

Path Parameters

Name	Type	Description
partner_id	integer	The id of the partner.

Query Parameters

Name	Type	Description
page	integer	The current page to display.
search	string	Filter users by the given string. It searches the users by first name, last name, and email address.

200 The partner users are returned.

{
    data: [
        {
            id: 1,
            first_name: "John",
            last_name: "Doe",
            email: "[email protected]"
        },
        {
            id: 2,
            first_name: "Jane",
            last_name: "Doe",
            email: "[email protected]"
        }
    ],

    meta: {
        current_page: 1,
        from: 1,
        to: 2,
        per_page: 20,
        total: 2,
    },
    
    links: {
        first: "https://manager.apis.venuzle.com/api/internal/v1/partners/1/users?search=Doe&page=1",
        last: "https://manager.apis.venuzle.com/api/internal/v1/partners/1/users?search=Doe&page=1",
        prev: null,
        next: null
    }
}

401 The user is not authenticated.

{}

403 The user performing the has no access to the partner or the permission users.read is missing.

{}

404 The partner could not be found.

{}

Create a new user

POST /api/internal/v1/partners/:partner_id/users

Create a new user and attach it to the partner. If a user already exists with that email and is not attached to the given partner, it will be attached and the first_name and last_name differences will be ignored. The action must be performed by an authenticated user with permission users.create and partner access.

Path Parameters

Name	Type	Description
partner_id	integer	The id of the partner.

Request Body

Name	Type	Description
password	string	The password of the new user.
email	string	The email address of the new user.
last_name	string	The last name of the new user.
first_name	string	The first name of the new user.

201 The user was created and attached to the partner.

{
    data: {
        id: 1,
        first_name: "John",
        last_name: "Doe",
        email: "[email protected]"
    }
}

401 The request was made without having an authenticated user.

{}

403 The user performing the action has no partner access or the permission users.create is missing.

{}

404 The partner could not be found.

{}

422 The data didn't pass the validation.

{
    message: "The given data was invalid.",
    errors: {
        first_name: [
            "The first_name field is required.",
            "The first_name field must be a string."
        ],
        
        last_name: [
            "The last_name field is required."
        ],
        
        email: [
            "The email field is required."
        ],
        
        password: [
            "The password field is required."
        ]
    }
}

Get user

GET /api/internal/v1/partners/:partner_id/users/:user_id

Get a user by its id. The action must be performed by an authenticated user with permission users.read and partner access.

Path Parameters

Name	Type	Description
user_id	integer	The id of the user.
partner_id	integer	The id of the partner.

200

{
    data: {
        id: 1,
        first_name: "John",
        last_name: "Doe",
        email: "[email protected]"
    }
}

401 The request was made without having an authenticated user.

{}

403 The user performing the action has no partner access or the permission users.read is missing.

{}

404 The partner or the user could not be found.

{}

Update user

PUT /api/internal/v1/partners/:partner_id/users/:user_id

Update the given user. The action must be performed by an authenticated user with permission users.update and partner access.

Path Parameters

Name	Type	Description
user_id	integer	The id of the user.
partner_id	integer	The id of the partner.

Request Body

Name	Type	Description
new_password_confirmation	string	Confirmation of the new user password.
new_password	string	The new password of the user.
email	string	The email of the user.
last_name	string	The last name of the user.
first_name	string	The first name of the user.

204 The user was successfully updated.

{}

401 The request was made without an authenticated user.

{}

403 The user performing the request has no partner access or the permission users.update is missing.

{}

404 The partner or the user could not be found.

{}

422 The data didn't pass the validation.

{
    message: "The given data was invalid.",
    errors: {
        first_name: [
            "The first_name must be betweet 2 and 70 characters long."
        ],
        
        last_name: [
            "The last_name must be betweet 2 and 70 characters long."
        ],
        
        email: [
            "The email must be a valid email address."
        ],
        
        password: [
            "The password must be betweet 6 and 255 characters long."
        ]
    }
}

Delete user

DELETE /api/internal/v1/partners/:partner_id/users/:user_id

Delete the given user. If the user is attached to multiple partners, it will be removed from the current partner only. The action must be performed by an authenticated user with permission users.delete and partner access.

Path Parameters

Name	Type	Description
user_id	integer	The user id which should be deleted.
partner_id	integer	The partner id.

204 The user was deleted.

{}

401 The request was made without an authenticated user.

{}

403 The user performing the request has no partner access or the permission users.delete is missing.

{}

404 The partner or the user could not be found.

{}

409 Returned when the user tries to delete its own account.

{}

Get user partners

GET /api/internal/v1/partners/:partner_id/users/:user_id

Get the partners associated with the given user.

Path Parameters

Name	Type	Description
user_id	integer
partner_id	integer

200