createPortalUserAccessProfile
Create user access profile
createPortalUserAccessProfile(
input: CreatePortalUserAccessProfileInput!
): CreatePortalUserAccessProfilePayload
Arguments
createPortalUserAccessProfile.input ● CreatePortalUserAccessProfileInput! non-null input
Parameters for CreatePortalUserAccessProfile
Type
CreatePortalUserAccessProfilePayload object
Autogenerated return type of CreatePortalUserAccessProfile.
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 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":"mutation MutateCreatePortalUserAccessProfile($input: CreatePortalUserAccessProfileInput!) {\n createPortalUserAccessProfile(input: $input) { clientMutationId profile { id name assetPermissions } }\n}","variables":{"input":{"params":{"name":"example","companyId":1,"projectPermissions":["create_projects"],"userAccessPermissions":["view_user_access"],"vulnerabilityPermissions":["VIEW"],"integrationPermissions":["manage_integrations"],"assetPermissions":["view_asset"],"programPermissions":["edit_program"],"attachmentPermissions":["VIEW"],"credentialPermissions":["VIEW"],"requirementPermissions":["VIEW"],"threatModelingPermissions":["VIEW"],"notificationPermissions":["manage_notification"],"ticketPermissions":["MANAGE"]}}}}'
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 MutateCreatePortalUserAccessProfile($input: CreatePortalUserAccessProfileInput!) {\n createPortalUserAccessProfile(input: $input) { clientMutationId profile { id name assetPermissions } }\n}",
variables: {
"input": {
"params": {
"name": "example",
"companyId": 1,
"projectPermissions": [
"create_projects"
],
"userAccessPermissions": [
"view_user_access"
],
"vulnerabilityPermissions": [
"VIEW"
],
"integrationPermissions": [
"manage_integrations"
],
"assetPermissions": [
"view_asset"
],
"programPermissions": [
"edit_program"
],
"attachmentPermissions": [
"VIEW"
],
"credentialPermissions": [
"VIEW"
],
"requirementPermissions": [
"VIEW"
],
"threatModelingPermissions": [
"VIEW"
],
"notificationPermissions": [
"manage_notification"
],
"ticketPermissions": [
"MANAGE"
]
}
}
},
}),
});
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 MutateCreatePortalUserAccessProfile($input: CreatePortalUserAccessProfileInput!) {\n createPortalUserAccessProfile(input: $input) { clientMutationId profile { id name assetPermissions } }\n}",
'variables': json.loads("{\"input\":{\"params\":{\"name\":\"example\",\"companyId\":1,\"projectPermissions\":[\"create_projects\"],\"userAccessPermissions\":[\"view_user_access\"],\"vulnerabilityPermissions\":[\"VIEW\"],\"integrationPermissions\":[\"manage_integrations\"],\"assetPermissions\":[\"view_asset\"],\"programPermissions\":[\"edit_program\"],\"attachmentPermissions\":[\"VIEW\"],\"credentialPermissions\":[\"VIEW\"],\"requirementPermissions\":[\"VIEW\"],\"threatModelingPermissions\":[\"VIEW\"],\"notificationPermissions\":[\"manage_notification\"],\"ticketPermissions\":[\"MANAGE\"]}}}"),
},
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