POST User sessions & access

Set user permissions (not implemented)

This endpoint is present in the API contract but does not currently apply permission changes.

POST /api/v3/{appid}/user/users/{userid}/setroles

This endpoint is present in the API contract but does not currently apply permission changes.

Do not use it in production. Use Create or Update User to change the stored role, or Set a user role for the supported role-change operation.

Request

Parameters

Values in the path and query string.

appid path

string TalkLabs ID required

The application the user belongs to.

Example: your-app-id

userid path

string customer-defined required

The user the permissions would apply to.

Example: u-8842

Request

JSON body

Send as application/json.

roles

AccessRole[]

Required. An array of granular permission records to apply to the user, e.g. admin on one specific room while holding the "user" role at the application level. NOTE: as of this writing the server action that binds this form POST .../setroles does not yet apply it see that action's remarks.

Request example

{
  "roles": [
    "<roles>"
  ]
}

Response

Status codes

Every JSON response uses the API result envelope.

200 OK: request accepted, but no permission change is actually applied see NOTE above . ApiResult

400 BadRequest: the request body was not provided. ApiResult

403 Forbidden: request is not authorized with a valid token. ApiResult

500 Internal Server Error ApiResult

curl --request POST \
  --url "https://api.sportstalk247.com/api/v3/${APP_ID}/user/users/${USER_ID}/setroles" \
  --header "Accept: application/json" \
  --header "x-api-token: ${TALKLABS_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "roles": [
    "<roles>"
  ]
}'

const appId = process.env.TALKLABS_APP_ID;
const userid = 'u-8842';

const response = await fetch(
  `https://api.sportstalk247.com/api/v3/${appId}/user/users/${userid}/setroles`,
{
  method: 'POST',
  headers: {
    Accept: 'application/json',
    'x-api-token': process.env.TALKLABS_API_TOKEN,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "roles": [
    "<roles>"
  ]
}),
});

const result = await response.json();

import json
import os
import requests

app_id = os.environ["TALKLABS_APP_ID"]
userid = "u-8842"

response = requests.post(
    f"https://api.sportstalk247.com/api/v3/{app_id}/user/users/{userid}/setroles",
    headers={
        "Accept": "application/json",
        "x-api-token": os.environ["TALKLABS_API_TOKEN"],
    },
    json=json.loads(r'''{
  "roles": [
    "<roles>"
  ]
}'''),
)
response.raise_for_status()
result = response.json()

Environment variables TALKLABS_APP_ID TALKLABS_API_TOKEN

Response