Access checks

Overview

The Access checks resource is part of the Paycux API. Every field below is returned on every representation of the object, so you can rely on its shape across list, read and write calls.

Endpoints

Every endpoint is authenticated with a bearer token and scoped to the environment the key belongs to.

Check authorization

POST /authorization/organization_memberships/:organization_membership_id/check — check authorization.

1import Paycux from '@paycux/node';
2 
3const paycux = new Paycux(process.env.PAYCUX_API_KEY);
4 
5const result = await paycux.check_authorization();
6console.log(result);

List resources for an organization membership

GET /authorization/organization_memberships/:organization_membership_id/resources — list resources for an organization membership.

1import Paycux from '@paycux/node';
2 
3const paycux = new Paycux(process.env.PAYCUX_API_KEY);
4 
5const result = await paycux.list_resources_for_an_organization_membership();
6console.log(result);

List memberships for a resource

GET /authorization/resources/:resource_id/organization_memberships — list memberships for a resource.

1import Paycux from '@paycux/node';
2 
3const paycux = new Paycux(process.env.PAYCUX_API_KEY);
4 
5const result = await paycux.list_memberships_for_a_resource();
6console.log(result);

List memberships for a resource by external ID

GET /authorization/organizations/:organization_id/resources/:resource_type_slug/:external_id/organization_memberships — list memberships for a resource by external ID.

1import Paycux from '@paycux/node';
2 
3const paycux = new Paycux(process.env.PAYCUX_API_KEY);
4 
5const result = await paycux.list_memberships_for_a_resource_by_external_id();
6console.log(result);

List effective permissions for an organization membership on a resource

GET /authorization/organization_memberships/:organization_membership_id/resources/:resource_id/permissions — list effective permissions for an organization membership on a resource.

1import Paycux from '@paycux/node';
2 
3const paycux = new Paycux(process.env.PAYCUX_API_KEY);
4 
5const result = await paycux.list_effective_permissions_for_an_organization_membership_on_a_resource();
6console.log(result);

List effective permissions for an organization membership on a resource by external ID

List effective permissions for an organization membership on a resource by external ID controls what the credential is allowed to do. Grant the narrowest set that lets the integration work, and widen it deliberately.

Scopes are evaluated at the API boundary, so an over-broad token is a real risk even if your own code never uses the extra capability.

Errors

Errors return a JSON body with a machine-readable code, a human-readable message and, for validation failures, the offending field.