portalUserAccessEditImpact

Who saving updatePortalUserAccess with this input would take off what they are responsible for, and whether it would leave the user without any profile or out of the company. The status flags are left out: blocking or deactivating someone unassigns no one.

portalUserAccessEditImpact(
  input: UserAccessInput!
): AccessEditImpact!

Arguments

portalUserAccessEditImpact.input ● UserAccessInput! non-null input

What updatePortalUserAccess would be sent

Type

AccessEditImpact object

What saving an access edit would unassign, and whom it would leave without any profile or out of the company

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

curl --request POST https://api.convisoappsec.com/graphql \
  --header "x-api-key: $CONVISO_API_KEY" \
  --header "content-type: application/json" \
  --data '{"query":"query GetPortalUserAccessEditImpact($input: UserAccessInput!) {\n  portalUserAccessEditImpact(input: $input) { leftOutOfCompany { id name accesses { __typename } } leftWithoutProfile { id name accesses { __typename } } teamUnassignments { assets issues projects } }\n}","variables":{"input":{"portalUserId":"<portal_user_id>","companyId":"<company_id>"}}}'

JavaScript

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 GetPortalUserAccessEditImpact($input: UserAccessInput!) {\n  portalUserAccessEditImpact(input: $input) { leftOutOfCompany { id name accesses { __typename } } leftWithoutProfile { id name accesses { __typename } } teamUnassignments { assets issues projects } }\n}",
    variables: {
    "input": {
        "portalUserId": "<portal_user_id>",
        "companyId": "<company_id>"
    }
},
  }),
});

const { data, errors } = await response.json();

if (errors) throw new Error(errors.map(({ message }) => message).join(', '));
console.log(data);

Python

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 GetPortalUserAccessEditImpact($input: UserAccessInput!) {\n  portalUserAccessEditImpact(input: $input) { leftOutOfCompany { id name accesses { __typename } } leftWithoutProfile { id name accesses { __typename } } teamUnassignments { assets issues projects } }\n}",
        'variables': json.loads("{\"input\":{\"portalUserId\":\"<portal_user_id>\",\"companyId\":\"<company_id>\"}}"),
    },
    timeout=30,
)
response.raise_for_status()

payload = response.json()
if payload.get('errors'):
    raise RuntimeError(payload['errors'])

print(payload['data'])