{
"opencollection": "1.0.0",
"info": {
"name": "HighBond API Reference Actions Strategy API",
"version": "1.1.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Strategy",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get risks",
"type": "http"
},
"http": {
"method": "GET",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_risks",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "fields[strategy_risks]",
"value": "",
"type": "query",
"description": "Requesting the API to return only the specified fields. For more information, see Making requests"
},
{
"name": "page[size]",
"value": "",
"type": "query",
"description": "The number of items returned per page. Default is 20. Maximum is 100."
},
{
"name": "page[number]",
"value": "",
"type": "query",
"description": "The Base64-encoded page number of records to return."
}
]
},
"docs": "Retrieves the full list of the organization's risks from\nStrategy.\n
\nA strategic risk is an effect of uncertainty on a strategic objective, with the effect having a positive or\nnegative deviation from what is expected.
\nThe `status` field is the current state of the risk on the Kanban Board,\nits"
},
{
"info": {
"name": "Create a risk",
"type": "http"
},
"http": {
"method": "POST",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_risks",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new risk in Strategy.\n
\nA strategic risk is an effect of uncertainty on a strategic objective, with the effect having a positive or\nnegative deviation from what is expected.\n
\nThe `status` field is the current state of the risk on the Kanban Board,\nits values can be:\n - `assess`\n - `acc"
},
{
"info": {
"name": "Get a risk",
"type": "http"
},
"http": {
"method": "GET",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_risks/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
},
{
"name": "fields[strategy_risks]",
"value": "",
"type": "query",
"description": "Requesting the API to return only the specified fields. For more information, see Making requests"
}
]
},
"docs": "Get information about a risk."
},
{
"info": {
"name": "Update a risk",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_risks/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Make changes to a risk, including updating the risk's title, description, status and custom attributes.\n
\nAssigning an empty array to the `strategy_custom_attributes` field will remove all custom attributes from the risk.\n"
},
{
"info": {
"name": "Delete a risk",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_risks/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
]
},
"docs": "Permanently delete a risk."
},
{
"info": {
"name": "Get risk assurances",
"type": "http"
},
"http": {
"method": "GET",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_risks/:risk_id/strategy_assurances",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "risk_id",
"value": "",
"type": "path",
"description": "The ID of the risk."
},
{
"name": "page[size]",
"value": "",
"type": "query",
"description": "The number of items returned per page. Default is 20. Maximum is 100."
},
{
"name": "page[number]",
"value": "",
"type": "query",
"description": "The Base64-encoded page number of records to return."
}
]
},
"docs": "Retrieves the list of assurances for the current risk from\nStrategy.\n
\n\nAssurances link risks in Strategy to testing results, issues and controls inside the\nProjects\napplication.\nSee the Projects Strategy.\n
\nComments can have multiple file attachments. These can be retrieved via the\nComment resource.\n\nThe `user_id` points to the user's unique identifier who created the comment.\nThe Strategy.\n
\nA strategic objective is a business process, functional area, or auditable area that relates to an operating segment.\nThe organization's objectives can be accessed with the\nObjectives resource.\n"
},
{
"info": {
"name": "Create a risk objective link",
"type": "http"
},
"http": {
"method": "POST",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_risks/:risk_id/strategy_objectives",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "risk_id",
"value": "",
"type": "path",
"description": "The ID of the risk."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new link between a risk and an objective.\n"
},
{
"info": {
"name": "Get a risk objective",
"type": "http"
},
"http": {
"method": "GET",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_risks/:risk_id/strategy_objectives/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "risk_id",
"value": "",
"type": "path",
"description": "The ID of the risk."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
]
},
"docs": "Get information about a risk's objective."
},
{
"info": {
"name": "Delete a risk objective link",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_risks/:risk_id/strategy_objectives/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "risk_id",
"value": "",
"type": "path",
"description": "The ID of the risk."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
]
},
"docs": "Delete a link between a risk and an objective.\n"
},
{
"info": {
"name": "Get risk segments",
"type": "http"
},
"http": {
"method": "GET",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_risks/:risk_id/strategy_segments",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "risk_id",
"value": "",
"type": "path",
"description": "The ID of the risk."
},
{
"name": "page[size]",
"value": "",
"type": "query",
"description": "The number of items returned per page. Default is 20. Maximum is 100."
},
{
"name": "page[number]",
"value": "",
"type": "query",
"description": "The Base64-encoded page number of records to return."
}
]
},
"docs": "Retrieves the full list of the risks's operating segments from\nStrategy.\n
\nAn operating segment is a region, business unit, division, location, or entity across which strategic risks are assessed.\nThe organization's operating segments can be accessed with the\nSegments resource.\n"
},
{
"info": {
"name": "Get a risk segment",
"type": "http"
},
"http": {
"method": "GET",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_risks/:risk_id/strategy_segments/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "risk_id",
"value": "",
"type": "path",
"description": "The ID of the risk."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
},
{
"name": "fields[strategy_segments]",
"value": "",
"type": "query",
"description": "Requesting the API to return only the specified fields for the segment. For more information, see Making requests"
},
{
"name": "fields[strategy_factors]",
"value": "",
"type": "query",
"description": "Requesting the API to return only the specified fields for treatments. For more information, see Making requests"
}
]
},
"docs": "Get information about an operating segment for the risk.\nThe field `strategy_factors` lists the values of the assessed severity levels for the current segment of the risk.\nTo get information about this factor, use the Factor\nresource.\n\nTo fetch the treatment data, you can specify the required fields via the `fields[strategy_segments]` or\n`fields[strategy_factors]` query parameters, as described below.\n"
},
{
"info": {
"name": "Update a risk segment",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_risks/:risk_id/strategy_segments/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "risk_id",
"value": "",
"type": "path",
"description": "The ID of the risk."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Make changes to a risk segment, including updating the segment's severity values and treatment weights.\n"
},
{
"info": {
"name": "Get risk metrics",
"type": "http"
},
"http": {
"method": "GET",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_risks/:risk_id/strategy_metrics",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "risk_id",
"value": "",
"type": "path",
"description": "The ID of the risk."
},
{
"name": "page[size]",
"value": "",
"type": "query",
"description": "The number of items returned per page. Default is 20. Maximum is 100."
},
{
"name": "page[number]",
"value": "",
"type": "query",
"description": "The Base64-encoded page number of records to return."
}
]
},
"docs": "Retrieves the list of metrics linked to the current risk from\nStrategy.\n
\nA metric is a calculation that can be labeled as a specific type of key indicator.
\n\nThis list contains the metric's URI as `metric_uri` pointing to the specific Metric inside the\nStrategy.\n
\nTags are associated with strategic risks, and aid in organizing and filtering risks for heatmap creation and other\nvisualization.\nThe organization's tags can be accessed with the\nTags resource.\n"
},
{
"info": {
"name": "Create a risk tag link",
"type": "http"
},
"http": {
"method": "POST",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_risks/:risk_id/strategy_tags",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "risk_id",
"value": "",
"type": "path",
"description": "The ID of the risk."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new link between a risk and a tag.\n"
},
{
"info": {
"name": "Delete a risk tag link",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_risks/:risk_id/strategy_tags/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "risk_id",
"value": "",
"type": "path",
"description": "The ID of the risk."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
]
},
"docs": "Delete a link between a risk and a tag.\n"
},
{
"info": {
"name": "Get objectives",
"type": "http"
},
"http": {
"method": "GET",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_objectives",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "page[size]",
"value": "",
"type": "query",
"description": "The number of items returned per page. Default is 20. Maximum is 100."
},
{
"name": "page[number]",
"value": "",
"type": "query",
"description": "The Base64-encoded page number of records to return."
}
]
},
"docs": "Retrieves the full list of the organization's objectives from\nStrategy.\n
\nA strategic objective is a business process, functional area, or auditable area that relates to an operating segment.\nA risk's objectives can be accessed with the\nRisk objectives resource.\n"
},
{
"info": {
"name": "Create an objective",
"type": "http"
},
"http": {
"method": "POST",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_objectives",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new objective.\n"
},
{
"info": {
"name": "Get an objective",
"type": "http"
},
"http": {
"method": "GET",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_objectives/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
]
},
"docs": "Get information about an objective.\n"
},
{
"info": {
"name": "Update an objective",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_objectives/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Make changes to an objective, including updating the objective's name or linking it to segments.\n"
},
{
"info": {
"name": "Delete an objective",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_objectives/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
]
},
"docs": "Permanently delete an objective.\n"
},
{
"info": {
"name": "Get segments",
"type": "http"
},
"http": {
"method": "GET",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_segments",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "page[size]",
"value": "",
"type": "query",
"description": "The number of items returned per page. Default is 20. Maximum is 100."
},
{
"name": "page[number]",
"value": "",
"type": "query",
"description": "The Base64-encoded page number of records to return."
}
]
},
"docs": "Retrieves the full list of the organization's segments from\nStrategy.\n
\nAn operating segment is a region, business unit, division, location, or entity across which strategic risks are assessed.\nA risk's segments can be accessed with the\nRisk segments resource.\n"
},
{
"info": {
"name": "Create a segment",
"type": "http"
},
"http": {
"method": "POST",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_segments",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new segment.\n"
},
{
"info": {
"name": "Get a segment",
"type": "http"
},
"http": {
"method": "GET",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_segments/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
]
},
"docs": "Get information about an operating segment."
},
{
"info": {
"name": "Update a segment",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_segments/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Make changes to an objective, including updating the segment's name or linking it to objectives.\n"
},
{
"info": {
"name": "Delete a segment",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_segments/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
]
},
"docs": "Permanently delete a segment.\n"
},
{
"info": {
"name": "Get custom attributes",
"type": "http"
},
"http": {
"method": "GET",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_custom_attributes",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "page[size]",
"value": "",
"type": "query",
"description": "The number of items returned per page. Default is 20. Maximum is 100."
},
{
"name": "page[number]",
"value": "",
"type": "query",
"description": "The Base64-encoded page number of records to return."
}
]
},
"docs": "Retrieves the full list of the organization's custom attribute definitions from\nStrategy.\n
\nEach organization can have a maximum of 10 user-defined attributes, which can be associated with each risk inside\nthe application.\nThe `field_type` specifies the data type of the attribute. Its value can be one of the following:\n- `text`\n- `rich_text`\n- `select`\n- `multiselect"
},
{
"info": {
"name": "Create a custom attribute",
"type": "http"
},
"http": {
"method": "POST",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_custom_attributes",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new custom attribute.\nUpdates the organization's custom attribute definitions in\nStrategy.\n
\nEach organization can have a maximum of 10 user-defined attributes, which can be associated with each risk inside\nthe application.\nThe `field_type` specifies the data type of the attribute. Its value can be one of the following:\n- `text`\n- `rich_text`\n- `select`\n- `m"
},
{
"info": {
"name": "Get a custom attribute",
"type": "http"
},
"http": {
"method": "GET",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_custom_attributes/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
]
},
"docs": "Retrieves the definition of a custom attribute."
},
{
"info": {
"name": "Update a custom attribute",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_custom_attributes/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Make changes to the definition of a custom attribute, including updating its term or options in\nStrategy.\n
\nEach organization can have a maximum of 10 user-defined attributes, which can be associated with each risk inside\nthe application.\nThe `field_type` specifies the data type of the attribute. Its value can be one of the following:\n- `text`\n- `rich_text`\n- `select"
},
{
"info": {
"name": "Delete a custom attribute",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_custom_attributes/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
]
},
"docs": "Permanently delete a custom attribute.\n"
},
{
"info": {
"name": "Get risk status columns",
"type": "http"
},
"http": {
"method": "GET",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_kanban_columns",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
}
]
},
"docs": "Retrieves the risk status board from\nStrategy.\n
\nEach column lists the risks contained inside that column.
\nThe `id` can be one of the following:\n - `assess`\n - `accepted`\n - `audit`\n - `continuously_audit`\n - `mitigated`\n\nThis information is also provided inside the Risk\nresource as the field `statu"
},
{
"info": {
"name": "Get a risk status column",
"type": "http"
},
"http": {
"method": "GET",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_kanban_columns/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
]
},
"docs": "List all the risks inside a risk status column."
},
{
"info": {
"name": "Get scoring factors",
"type": "http"
},
"http": {
"method": "GET",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_factors",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "page[size]",
"value": "",
"type": "query",
"description": "The number of items returned per page. Default is 20. Maximum is 100."
},
{
"name": "page[number]",
"value": "",
"type": "query",
"description": "The Base64-encoded page number of records to return."
}
]
},
"docs": "Retrieves the full list of the organization's risk scoring factors from\nStrategy.\n
\nRisk scoring factors are multiplied together to calculate the risk score, with each risk scoring factor\nmultiplied by its assigned weight.\nStrategy.\n
\nTags are associated with strategic risks, and aid in organizing and filtering risks for heatmap creation and other\nvisualization.\nA risk's tags can be accessed with the\nRisk tags resource.\n"
},
{
"info": {
"name": "Create a tag",
"type": "http"
},
"http": {
"method": "POST",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_tags",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new tag.\n"
},
{
"info": {
"name": "Get a tag",
"type": "http"
},
"http": {
"method": "GET",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_tags/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
]
},
"docs": "Get information about a tag."
},
{
"info": {
"name": "Update a Tag",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_tags/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Make changes to a tag, including updating the tag's name or linking it to segments.\n"
},
{
"info": {
"name": "Delete a tag",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_tags/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
]
},
"docs": "Permanently delete a tag.\n"
},
{
"info": {
"name": "Get users",
"type": "http"
},
"http": {
"method": "GET",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_users",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "page[size]",
"value": "",
"type": "query",
"description": "The number of items returned per page. Default is 20. Maximum is 100."
},
{
"name": "page[number]",
"value": "",
"type": "query",
"description": "The Base64-encoded page number of records to return."
}
]
},
"docs": "Retrieves the full list of the organization's users from\nStrategy.\n
\n"
},
{
"info": {
"name": "Get a user",
"type": "http"
},
"http": {
"method": "GET",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_users/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
]
},
"docs": "Get information about a user."
},
{
"info": {
"name": "Update a user role",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{protocol}://{server}/v1/orgs/:org_id/strategy_users/:id",
"params": [
{
"name": "org_id",
"value": "",
"type": "path",
"description": "The ID of the HighBond instance."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the requested resource."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Make changes to a user's role.\n\nThe `role` attribute is required and must be one of the following values:\n- `admin`\n- `executive`\n- `reviewer`\n- `no_access`\n"
}
]
}
],
"bundled": true
}