API docs by Redocly

Site Features Users API (1.2.0)

Download OpenAPI specification:

Endpoints for managing feature users on a site.

Feature Users

Operations for managing feature users' enrollment.

List users

Returns users with optional filtering and pagination.

Authorizations:
BearerAuth
path Parameters
featureId
required
string
query Parameters
email
string <email>

Filter by email.

limit
integer >= 0

Maximum number of users to return.

offset
integer >= 0

Number of users to skip before collecting result rows.

Responses

Response samples

Content type
application/json
{
  • "featureUsers": [
    ],
  • "limit": 10,
  • "offset": 0,
  • "count": 50
}

Add or update user

Creates a new user or updates an existing user if the ID already exists.

Authorizations:
BearerAuth
path Parameters
featureId
required
string
userId
required
string
Request Body schema: application/json
required
email
required
string <email>

The email address of the user in the feature

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{
  • "userId": "string",
  • "email": "user@example.com",
  • "status": "PENDING_TOS",
  • "lastUpdated": 0
}

Remove user

Deletes a user.

Authorizations:
BearerAuth
path Parameters
featureId
required
string
userId
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "detail": "string",
  • "errors": [
    ],
  • "code": "E000"
}

Upload user image

Validates and uploads an image for a user

Authorizations:
BearerAuth
path Parameters
featureId
required
string
userId
required
string
Request Body schema: multipart/form-data
required
image
required
string <binary>

The image file to upload for the user's profile.

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "detail": "string",
  • "errors": [
    ],
  • "code": "E000"
}

Get user consent

Retrieves the user's consent status.

Authorizations:
BearerAuth
path Parameters
featureId
required
string
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "ACTIVE"
}

Update user consent

Provides consent for the user.

Authorizations:
BearerAuth
path Parameters
featureId
required
string
userId
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "detail": "string",
  • "errors": [
    ],
  • "code": "E000"
}

Revoke user consent

Revokes the user's consent.

Authorizations:
BearerAuth
path Parameters
featureId
required
string
userId
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "detail": "string",
  • "errors": [
    ],
  • "code": "E000"
}

Update terms of service consent

Accepts the terms of service for the user.

Authorizations:
BearerAuth
path Parameters
featureId
required
string
userId
required
string

Responses

Response samples

Content type
application/problem+json
{
  • "title": "string",
  • "detail": "string",
  • "errors": [
    ],
  • "code": "E000"
}