Skip to navigation
APIsStudy ResourcesStudy Users

Create a study user

Create a user on the study.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

studyIdstringRequiredformat: "^sdy_[a-zA-Z0-9]{10,22}$"
The unique identifier of the study.
userIdstringRequiredformat: "^usr_[a-zA-Z0-9]{10,22}$"
The unique identifier of the user.

Headers

X-Studies-Api-VersionstringOptional

Request

The attributes of the study user to create.
accessenumRequired
The permission of the user on the study.
Allowed values:

Response headers

X-RateLimit-LimitintegerOptional
The number of requests permitted in the current rate limit window.
X-RateLimit-RemainingintegerOptional

The number of requests still available in the current rate limit window. When several limits apply, this reflects the per-API-key limit, so a request can be rejected while this value is above zero.

X-RateLimit-ResetintegerOptional
The number of seconds until the current rate limit window resets.

Response

The study user was created.
idstringformat: "^usr_[a-zA-Z0-9]{10,22}$"
Unique identifier for a user.
namestring<=255 characters
The name of the user.
emailstringformat: "email"
The email address of the user.
timezonestring

The timezone of the user. Defaults to UTC when the user has none set.

typeenum

The role a user holds on a study. Derived from the study’s author and owner assignments; every other member is team.

Allowed values:
accessenum
Level of access a team member has to a study.
Allowed values:
studyobject
The study a record belongs to, as embedded in animals, dosages, measurements, observations and samples. Carries the same attributes as a study retrieved directly, except that the project is given as an identifier rather than an embedded object.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error