Get an access policy

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

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

The policyId is in the list of access policies and in the response of Create an access policy.

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.
policyId	Path	string	Yes	The ID of the access policy. An unknown ID returns 404.

Request example

cURL

curl "$API_BASE_URL/organizations/$ORGANIZATION_ID/contexts/sign-in/$CONTEXT_ID/access-policies/66f2a1c4e8b0a93d5c1e7f20" \
  -H "Authorization: Bearer $NCP_API_TOKEN"

Response

200 with the policy. The fields are described in the access policy object.

Response example

200

{
  "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
}

Errors

Status	errorCode	When
404	RESOURCE_NOT_FOUND	The context has no access policy with this ID, 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.