generateSamlIntegrationProvisioningKey
Generates the provisioning key of an SSO integration; returns its token only once
generateSamlIntegrationProvisioningKey(
input: GenerateSamlIntegrationProvisioningKeyInput!
): GenerateSamlIntegrationProvisioningKeyPayload
Arguments
generateSamlIntegrationProvisioningKey.input ● GenerateSamlIntegrationProvisioningKeyInput! non-null input
Parameters for GenerateSamlIntegrationProvisioningKey
Type
GenerateSamlIntegrationProvisioningKeyPayload object
Autogenerated return type of GenerateSamlIntegrationProvisioningKey.
Example request
This generated mutation uses placeholders for required values. Replace them with values available to your API key before running it.
Before you run it
Run the integrations query first and use data.integrations.collection[].id as integrationId.
- 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":"mutation MutateGenerateSamlIntegrationProvisioningKey($input: GenerateSamlIntegrationProvisioningKeyInput!) {\n generateSamlIntegrationProvisioningKey(input: $input) { clientMutationId provisioningKey { id name status } token }\n}","variables":{"input":{"integrationId":"<integration_id>","expiresAt":"<ISO8601DateTime>"}}}'
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: "mutation MutateGenerateSamlIntegrationProvisioningKey($input: GenerateSamlIntegrationProvisioningKeyInput!) {\n generateSamlIntegrationProvisioningKey(input: $input) { clientMutationId provisioningKey { id name status } token }\n}",
variables: {
"input": {
"integrationId": "<integration_id>",
"expiresAt": "<ISO8601DateTime>"
}
},
}),
});
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': "mutation MutateGenerateSamlIntegrationProvisioningKey($input: GenerateSamlIntegrationProvisioningKeyInput!) {\n generateSamlIntegrationProvisioningKey(input: $input) { clientMutationId provisioningKey { id name status } token }\n}",
'variables': json.loads("{\"input\":{\"integrationId\":\"<integration_id>\",\"expiresAt\":\"<ISO8601DateTime>\"}}"),
},
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