Skip to main content

apiKeyAccessEditImpact

Who saving updateApiKey with these arguments would take off what they are responsible for, and whether it would leave the account without any profile. Only a service key's save touches accesses.

apiKeyAccessEditImpact(
id: ID!
companyId: ID!
accessProfileId: ID
teamIds: [ID!]
accesses: AccessInput
): AccessEditImpact!

Arguments​

apiKeyAccessEditImpact.id ● ID! non-null scalar​

apiKeyAccessEditImpact.companyId ● ID! non-null scalar​

apiKeyAccessEditImpact.accessProfileId ● ID scalar​

As on updateApiKey: leaving it out, or sending null or an empty string, takes the account's own profile away.

apiKeyAccessEditImpact.teamIds ● [ID!] list scalar​

As on updateApiKey: leaving it out keeps the account's teams.

apiKeyAccessEditImpact.accesses ● AccessInput input​

As on updateApiKey: leaving it out keeps the account's direct accesses.

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 --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"query GetApiKeyAccessEditImpact($id: ID!, $companyId: ID!) {\n apiKeyAccessEditImpact(id: $id, companyId: $companyId) { leftOutOfCompany { id name accesses { __typename } } leftWithoutProfile { id name accesses { __typename } } teamUnassignments { assets issues projects } }\n}","variables":{"id":"example-id","companyId":"<company_id>"}}'

Contribute to the Docs

Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.

How to contribute