setFormGrant

PUT

/api/v1/data-sources/{id}/grants

const url = 'https://example.com/api/v1/data-sources/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/grants';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"userId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","capability":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://example.com/api/v1/data-sources/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/grants \
  --header 'Content-Type: application/json' \
  --data '{ "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "capability": "example" }'

Adds one capability grant for a user on a Form Data Source (idempotent on form, user, and capability), in a single transaction with an audit entry. The target must be an existing user. Requires the manage capability and CSRF.

Parameters

Path Parameters

required

string format: uuid

Request Body^required

application/json

object

userId

required

string format: uuid

capability

required

string

Example^generated

{
  "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "capability": "example"
}

Responses

201

Grant created

403

Manage capability required

422

Unknown capability or user

setFormGrant

Parameters

Path Parameters

Request Bodyrequired

Examplegenerated

Responses

201

403

422

Request Body^required

Example^generated