Add a user to a project or component

POST

/memberships

Creates a membership linking a user to a project or component with the specified role (viewer, author, reviewer, admin). Requires admin role on the target project. Duplicate memberships are rejected.

Authorizations

cookieAuth

Type

API Key (cookie: _vulcan_session)

or

tokenAuth

Personal access token authentication. Send via Authorization header: Authorization: Token vulcan_xxx. Tokens are SHA-256 hashed server-side (never stored in plaintext). Scopes: read (GET), write (mutations), admin (everything). Create tokens via Settings → API Tokens in the web UI.

Type

HTTP (token)

Request Body

application/json

{

  

"membership": {

  

  

"user_id": 42,

  

  

"membership_id": 4,

  

  

"membership_type": "Project",

  

  

"role": "author"

  

}

}

Responses

Membership created

Content-Type

application/json

{

  

"toast": {

  

  

"title": "Member added.",

  

  

"message": [

  

  

  

"Jane Doe added as author."

  

  

],

  

  

"variant": "success"

  

}

}

POST

/memberships

Playground

Authorization

cookieAuth

Body

Samples

Powered by VitePress OpenAPI