Add an organization member

POST

/organizations/{organization}/members

Code sample: Shell / cURL

curl --request POST \
  --url https://api.grepvine.ai/v1/organizations/example/members \
  --header 'Content-Type: application/json' \
  --cookie __Host-grepvine-session=<__Host-grepvine-session> \
  --data '{ "user": "example", "role": "admin" }'

Authorizations

• cookieAuth
• apiKeyAuth

Parameters

Path Parameters

organization

required

An account or organization name. Accounts and organizations share one namespace. A name keeps the case it was created with, and any spelling that differs only in case refers to it; no other account or organization can take such a spelling.

string

/^[A-Za-z][A-Za-z0-9-]{2,62}$/

Header Parameters

X-Csrf-Token

string

>= 16 characters <= 256 characters

Required for a state change that uses cookie authentication.

Request Body^required

Media typeapplication/json

object

user

required

An account or organization name. Accounts and organizations share one namespace. A name keeps the case it was created with, and any spelling that differs only in case refers to it; no other account or organization can take such a spelling.

string

/^[A-Za-z][A-Za-z0-9-]{2,62}$/

role

required

string

Allowed values: admin developer reader

Responses

201

The member was added.

Media typeapplication/json

object

user

required

object

id

required

string format: uuid

name

required

An account or organization name. Accounts and organizations share one namespace. A name keeps the case it was created with, and any spelling that differs only in case refers to it; no other account or organization can take such a spelling.

string

/^[A-Za-z][A-Za-z0-9-]{2,62}$/

email

required

string format: email

created_at

required

string format: date-time

staff_role

The account’s role on the Grepvine team, when it has one. Omitted for every other account.

string

Allowed values: root support

role

required

string

Allowed values: owner admin developer reader

created_at

required

string format: date-time

expires_at

When the membership ends, for time-limited access granted by Grepvine support. Omitted for an ordinary membership.

string format: date-time

Example

{
  "user": {
    "staff_role": "root"
  },
  "role": "owner"
}

default

The request failed. A 429 carries Retry-After; the index is busy absorbing recent writes or is out of request capacity, and clients must slow down and retry after the interval. A 403 with code organization_suspended refuses every operation on a suspended organization’s members, indexes, documents and searches; reading the organization itself still answers and reports suspended, and the client should contact support.

Media typeapplication/json

object

code

required

string

reason

required

string

error

required

string

Example ^generated

{
  "code": "example",
  "reason": "example",
  "error": "example"
}

Headers

X-Request-Id

string

The request identifier used for support and audit correlation.

Retry-After

integer

Seconds to wait before retrying. Sent with every 429 so a client slows down instead of failing.