AccessControl

Managing user authentication and authorization workflows, ensuring secure access to the platform.

Create a new user account

post

Create a new user account

Body

application/jsonapplication/xmlapplication/x-www-form-urlencoded

first_namestringOptionalExample: Leo

last_namestringOptionalExample: Jourdain

usernamestringRequiredExample: LeoJr

passwordstringRequiredExample: astrongpasswrd

emailstringRequiredExample: [e-mail]

phone_numberstringOptionalExample: +33XXXXXXXXXX

Responses

200

Successful operation

application/jsonapplication/xml

400

Invalid information supplied

post

/access/api/signup

HTTPcURLJavaScriptPython

POST /access/api/signup HTTP/1.1
Host: 127.0.0.1:8000
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "first_name": "Leo",
  "last_name": "Jourdain",
  "username": "LeoJr",
  "password": "astrongpasswrd",
  "email": "[e-mail]",
  "phone_number": "+33XXXXXXXXXX"
}

application/jsonapplication/xmlapplication/x-www-form-urlencoded

{
  "first_name": "Leo",
  "last_name": "Jourdain",
  "username": "LeoJr",
  "password": "astrongpasswrd",
  "email": "[e-mail]",
  "phone_number": "+33XXXXXXXXXX"
}

Login

post

Get login credientials

Body

application/jsonapplication/xmlapplication/x-www-form-urlencoded

usernamestringRequiredExample: Leojr

passwordstringRequiredExample: astrongpasswd

Responses

200

Successful operation

application/jsonapplication/xml

400

Invalid credentials

post

/access/api/login

HTTPcURLJavaScriptPython

POST /access/api/login HTTP/1.1
Host: 127.0.0.1:8000
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "username": "Leojr",
  "password": "astrongpasswd"
}

application/jsonapplication/xmlapplication/x-www-form-urlencoded

{
  "refresh": "98this766is57a78token",
  "acces": "98this766is57another78token"
}

Retrieve user informations

get

Retrieve user informations. If no query parameters are provided, all the users are returned. Administrator rights are required.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitstringOptional

Response is paginated

Example: ?limit=5

usernamestringOptional

username

Example: Leooojr

rolestringOptional

the role sought

Example: VALIDATOR

Header parameters

AuthorizationstringRequired

authorization

Example: Bearer mytoken

Responses

200

successful operation

application/jsonapplication/xml

Responseone of

400

Invalid status value

401

Unauthorized

get

/access/api/user

HTTPcURLJavaScriptPython

GET /access/api/user HTTP/1.1
Host: 127.0.0.1:8000
Authorization: Bearer mytoken
Accept: */*

{
  "count": 123,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "username": "LeoJr",
      "email": "[e-mail]",
      "role": "READER"
    }
  ]
}

Update user information

put

Update user information. Administrator rights are required.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

usernamestringRequired

user to update

Example: leojr

Header parameters

AuthorizationstringRequired

authorization

Example: Bearer mytoken

Body

application/jsonapplication/xmlapplication/x-www-form-urlencoded

rolestring · enumRequiredExample: ANNOTATORPossible values:

Responses

200

successful operation

application/jsonapplication/xml

400

Invalid tag value

put

/access/api/user/{username}

HTTPcURLJavaScriptPython

PUT /access/api/user/{username} HTTP/1.1
Host: 127.0.0.1:8000
Authorization: Bearer mytoken
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "role": "ANNOTATOR"
}

application/jsonapplication/xmlapplication/x-www-form-urlencoded

{
  "succes": "Role updated to VALIDATOR."
}