portalUserByCompany

Returns portal users for the company

portalUserByCompany(
  companyId: ID!
  page: Int!
  limit: Int!
  params: PortalUserSearch
): PortalUserCollection

Arguments

portalUserByCompany.companyId ● ID! non-null scalar

portalUserByCompany.page ● Int! non-null scalar

portalUserByCompany.limit ● Int! non-null scalar

portalUserByCompany.params ● PortalUserSearch input

Type

PortalUserCollection object

PortalUserCollection type

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 GetPortalUserByCompany($companyId: ID!, $page: Int!, $limit: Int!) {\n  portalUserByCompany(companyId: $companyId, page: $page, limit: $limit) { collection { id name accesses { __typename } } metadata { currentPage limitValue totalCount } }\n}","variables":{"companyId":"<company_id>","page":1,"limit":1}}'

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 GetPortalUserByCompany($companyId: ID!, $page: Int!, $limit: Int!) {\n  portalUserByCompany(companyId: $companyId, page: $page, limit: $limit) { collection { id name accesses { __typename } } metadata { currentPage limitValue totalCount } }\n}",
    variables: {
    "companyId": "<company_id>",
    "page": 1,
    "limit": 1
},
  }),
});

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 GetPortalUserByCompany($companyId: ID!, $page: Int!, $limit: Int!) {\n  portalUserByCompany(companyId: $companyId, page: $page, limit: $limit) { collection { id name accesses { __typename } } metadata { currentPage limitValue totalCount } }\n}",
        'variables': json.loads("{\"companyId\":\"<company_id>\",\"page\":1,\"limit\":1}"),
    },
    timeout=30,
)
response.raise_for_status()

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

print(payload['data'])