XNAT API Documentation

User Management API

About

The XNAT User Management API allows site administrators to create users, manage their activation and validation status, and grant or revoke project and site access permissions. It also offers the ability to revoke any and all active login sessions for a given user.

Changes in version 1.9.1

In order to configure authorization for a user using the endpoints

POST to /xapi/users
PUT to /xapi/users/{username}

the authorization element in the JSON must include the type field as shown below:

Sample user payload
{
  "authorization": {
    ......
    "type": "default"
  },
  ........
}



API Spec

Open API Spec