List access policies

GET /organizations/{organizationId}/contexts/sign-in/{contextId}/access-policies

Permission: Sign In › Access Policies (Read). See API permissions.

Returns one page of access policies, ordered by name. Every policy is listed, the fallback policy included, with its email patterns and switches.

Request

Parameter	In	Type	Required	Description
organizationId	Path	string	Yes	The Organization ID of the API key. Any other ID returns 404.
contextId	Path	string	Yes	The ID of a Sign-In Context of the Organization. Any other ID returns 404.
limit	Query	integer	No	Access policies per page, 1 to 100. Default 20.
cursor	Query	string	No	The nextCursor of the previous page. Leave it out for the first page.

Request example

cURL

curl "$API_BASE_URL/organizations/$ORGANIZATION_ID/contexts/sign-in/$CONTEXT_ID/access-policies?limit=20" \
  -H "Authorization: Bearer $NCP_API_TOKEN"

Response

A page of access policies.

Field	Type	Description
items	object[]	The access policies on this page, ordered by name. Each has the fields of the access policy object.

Response example

200

{
  "items": [
    {
      "policyId": "66f2a1c4e8b0a93d5c1e7f20",
      "name": "Contractors",
      "default": false,
      "emailPatterns": ["@contractor.example"],
      "signInPermissions": { "meetingHost": false, "emailSelfProvisioning": true, "saml": false },
      "selfServicePortal": true,
      "selfServicePermissions": { "manageConferences": false, "manageWhitelistings": true },
      "siteBasedRedirect": false
    },
    {
      "policyId": "66f2a0b9e8b0a93d5c1e7f1a",
      "name": "Default",
      "default": true,
      "emailPatterns": [],
      "signInPermissions": { "meetingHost": false, "emailSelfProvisioning": true, "saml": false },
      "selfServicePortal": false,
      "selfServicePermissions": { "manageConferences": false, "manageWhitelistings": false },
      "siteBasedRedirect": false
    }
  ],
  "nextCursor": null
}

Errors

Status	errorCode	When
400	VALIDATION_FAILED	limit is outside 1 to 100, or cursor is not a cursor of this operation. errors names the parameter.
404	RESOURCE_NOT_FOUND	organizationId is not the Organization of the API key, or contextId is not one of its Sign-In Contexts.

Errors common to all operations are in Errors.