saltSecurityWritePermissionWarning
Warns (on check-connection) when the Salt key connects but lacks write scope
saltSecurityWritePermissionWarning(
companyId: ID!
integrationId: ID
): String
Arguments
saltSecurityWritePermissionWarning.companyId ● ID! non-null scalar
saltSecurityWritePermissionWarning.integrationId ● ID scalar
Which Salt environment to probe. Required once the company has several.
Type
String scalar
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example request
This generated query uses placeholders for required values. Replace them with values available to your API key before running it.
Before you run it
Run the companies query first and use data.companies.collection[].id as companyId.
- cURL
- JavaScript
- Python
curl --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"query GetSaltSecurityWritePermissionWarning($companyId: ID!) {\n saltSecurityWritePermissionWarning(companyId: $companyId)\n}","variables":{"companyId":"<company_id>"}}'
const response = await fetch('https://api.convisoappsec.com/graphql', {
method: 'POST',
headers: {
'content-type': 'application/json',
'x-api-key': process.env.CONVISO_API_KEY,
},
body: JSON.stringify({
query: "query GetSaltSecurityWritePermissionWarning($companyId: ID!) {\n saltSecurityWritePermissionWarning(companyId: $companyId)\n}",
variables: {
"companyId": "<company_id>"
},
}),
});
const { data, errors } = await response.json();
if (errors) throw new Error(errors.map(({ message }) => message).join(', '));
console.log(data);
import json
import os
import requests
response = requests.post(
'https://api.convisoappsec.com/graphql',
headers={
'content-type': 'application/json',
'x-api-key': os.environ['CONVISO_API_KEY'],
},
json={
'query': "query GetSaltSecurityWritePermissionWarning($companyId: ID!) {\n saltSecurityWritePermissionWarning(companyId: $companyId)\n}",
'variables': json.loads("{\"companyId\":\"<company_id>\"}"),
},
timeout=30,
)
response.raise_for_status()
payload = response.json()
if payload.get('errors'):
raise RuntimeError(payload['errors'])
print(payload['data'])
Contribute to the Docs
Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.
How to contribute