Skip to main content

Users and access

Use this workflow to review users, assign an access profile, invite a new user, or organise users into teams. Your API key must have permission to manage users in the target company.

List access profiles​

Start by finding the profile that represents the permissions you want to grant.

List access profiles

This generated query uses placeholders for required values. Replace them with values available to your API key before running it.

Before you run it

Use collection[].id as <access_profile_id> when inviting a user or updating access.

curl --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"query GetPortalUserAccessProfiles($companyId: ID!) {\n portalUserAccessProfiles(companyId: $companyId) {\n collection { id name assetPermissions }\n metadata { currentPage limitValue totalCount }\n }\n}","variables":{"companyId":"<company_id>"}}'

List users in a company​

Use the returned user ID to inspect or change one user's access.

List company users

This generated query uses placeholders for required values. Replace them with values available to your API key before running it.

Before you run it

Use collection[].id as <portal_user_id> in the access operations below.

curl --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"query GetPortalUserByCompany($companyId: ID!, $page: Int!, $limit: Int!) {\n portalUserByCompany(companyId: $companyId, page: $page, limit: $limit) {\n collection { id name }\n metadata { currentPage limitValue totalCount }\n }\n}","variables":{"companyId":"<company_id>","page":1,"limit":20}}'

Invite a user​

The invitation applies the selected access profile in the company scope.

Invite a user with an access profile

This generated mutation uses placeholders for required values. Replace them with values available to your API key before running it.

curl --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"mutation CreateInviteUser($input: CreateInviteUserInput!) {\n createInviteUser(input: $input) {\n msg\n }\n}","variables":{"input":{"companyId":"<company_id>","accessProfileId":"<access_profile_id>","emails":["new.user@example.com"],"accesses":{}}}}'

Review or change a user's access​

Use portalUserAccess to confirm the current profile, then assign a different profile when responsibilities change. This does not create a new user.

Review a user's current access

This generated query uses placeholders for required values. Replace them with values available to your API key before running it.

curl --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"query GetPortalUserAccess($portalUserId: ID!, $companyId: Int!) {\n portalUserAccess(portalUserId: $portalUserId, companyId: $companyId) {\n accessProfile { id name }\n portalUser { id name }\n }\n}","variables":{"portalUserId":"<portal_user_id>","companyId":1}}'

Assign a different access profile

This generated mutation uses placeholders for required values. Replace them with values available to your API key before running it.

curl --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"mutation UpdatePortalUserAccess($input: UpdatePortalUserAccessInput!) {\n updatePortalUserAccess(input: $input) {\n portalUserAccess {\n accessProfile { id name }\n portalUser { id name }\n }\n }\n}","variables":{"input":{"portalUserId":"<portal_user_id>","companyId":"<company_id>","accessProfileId":"<access_profile_id>"}}}'

Organise users into teams​

Use teams when access should be managed around a working group.

Create a team

This generated mutation uses placeholders for required values. Replace them with values available to your API key before running it.

curl --request POST https://api.convisoappsec.com/graphql \
--header "x-api-key: $CONVISO_API_KEY" \
--header "content-type: application/json" \
--data '{"query":"mutation CreateTeam($input: CreateTeamInput!) {\n createTeam(input: $input) {\n team { id label }\n }\n}","variables":{"input":{"companyId":"<company_id>","params":{"label":"Application Security"}}}}'

For custom access-profile permissions, team updates, removals, and other access operations, use the complete schema.

Contribute to the Docs

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

How to contribute