Users and roles

Give an account a role

POST/api/v1/admin/users/:id/roles

Who can use this: Site adminsAs Markdown

The account gets every permission the role carries. Giving site_admin makes it a full site admin. Giving a role the account already has changes nothing. Each grant is recorded in the audit log.

Parameters

Name	Where	What it is
id required	path	The account's number, from the account list.e.g. 7
role required	body	The role's name, as the role list shows it.e.g. auditor

Good to know

An unknown account answers 404, and an unknown role 400.

curl -s -X POST 'https://api.mailmasker.org/api/v1/admin/users/7/roles' \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"role":"auditor"}'

use Mojo::Base -strict;
use Mojo::UserAgent;

my $ua  = Mojo::UserAgent->new;
my $res = $ua->post('https://api.mailmasker.org/api/v1/admin/users/7/roles',
    { Authorization => "Bearer $ENV{TOKEN}" },
    json => { role => 'auditor' })->result;
die $res->code, ' ', ($res->json('/error') // $res->message), "\n" unless $res->is_success;
print $res->body, "\n";

homelab-cli admin users grant-role 7 auditor

Response 200 OK

{ "ok": true }