Skip to main content

Signup

Creates a new account

info

username field must be unique and valid (valid characters are: a-z A-Z 0-9 _-).

info

Only users with the admin role can register new users.

info

This operation requires admin role.

HTTP Request

POST /api/v2/sso/signup/

Parameters

NameInTypeRequiredDescription
ext_idbodyintegerfalseA unique external id identifying the user
usernamebodystringtrueThe username of the user. Max 255 characters. Letters, numbers and -/_ characters
emailbodystringfalseThe email of the user.
passwordbodystringfalseThe password of the user. If passed, the password must be at least 8 characters (max 128 chararacters) and it must contains at least 3 of the following 4 types of characters: lower case letters, upper case letters, numbers and special characters (eg !@#$%^&)
avatarbodyurlfalseThe avatar of the user
rolebodystring¦nullfalseRole of the user; it can be: admin, moderator, editor
tagsbodylist(integer)¦nullfalseList of tags id

Example Body Parameters

{
"ext_id": "integer",
"username": "string",
"role": "string",
"tags": ["integer"]
}

Example Request

const inputBody = '{
"username": "string",
"ext_id": "integer"
}';
const headers = {
'Authorization':'Bearer {access_token}',
'Content-Type':'application/json',
'Accept':'application/json'
};

fetch('/api/v2/sso/signup/',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});

Responses

StatusMeaningDescriptionSchema
201CreatedResponse status codeInline

Response Schema

Status Code 201

NameTypeRequiredRestrictionsDescription
» idintegertruenoneThe unique internal id associated to the created user
» ext_idinteger¦nulltruenoneA unique external id identifying the user
» usernamestringtruenoneUsername of the registered user
» emailstringfalsenoneEmail of the registered user
» rolestring¦nullfalsenoneRole of the user; it can be: admin, moderator, editor
» tags["integer"]¦nullfalsenoneList of tags id

Example responses

{
"id": "integer",
"ext_id": "integer",
"username": "string",
"role": "string",
"tags": ["integer"]
}