API Reference

Configures employee-portal access for a single employee.

post
https://example.com/wep/companies//employees-access//employee-portal

Access: System, Admin, and ClientAdmin users only.

Use this endpoint to enable or disable portal access, set an expiration date, choose the contact email, and optionally provision invitation, password, or SSO access for the employee.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Company identifier from the route.

int32
required

Employee identifier from the route.

Body Params

Requested employee-portal access configuration.

Request payload used to configure employee-portal access for one employee.

date | null

Date on which employee-portal access should expire, or null to keep access without an expiration date.
Data type is validated and must be Number

boolean | null
required

Indicates whether employee-portal access should be enabled or disabled.

portalContactEmail
object

Contact-email settings used when provisioning employee-portal access.

string | null

Password to provision for the employee when creating password-based access. Do not combine with invitation or incomplete SSO data.

string | null

External SSO provider code used when provisioning employee-portal SSO access.

string | null

Secondary identifier sent to the SSO provider when registering the employee account.

string | null

Primary user identifier or subject key expected by the external SSO provider.

boolean | null

Set true to remove external SSO from an existing account and switch it back to password login.
Requires the account to have (or receive in the same request) a password. null = no change.

Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

Responses

Updated about 1 month ago

Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago