WorkOS
in package
Table of Contents
Properties
- $actions : Actions|null
- $adminPortal : AdminPortal|null
- $apiKey : string|null
- $apiKeys : ApiKeys|null
- $auditLogs : AuditLogs|null
- $authorization : Authorization|null
- $clientId : string|null
- $connect : Connect|null
- $directorySync : DirectorySync|null
- $events : Events|null
- $featureFlags : FeatureFlags|null
- $groups : Groups|null
- $httpClient : HttpClient|null
- $multiFactorAuth : MultiFactorAuth|null
- $organizationDomains : OrganizationDomains|null
- $organizations : Organizations|null
- $passwordless : Passwordless|null
- $pipes : Pipes|null
- $pkce : PKCEHelper|null
- $radar : Radar|null
- $sessionManager : SessionManager|null
- $sso : SSO|null
- $userManagement : UserManagement|null
- $userManagementOrganizationMembershipGroups : UserManagementOrganizationMembershipGroups|null
- $vault : Vault|null
- $webhooks : Webhooks|null
- $webhookVerification : WebhookVerification|null
- $widgets : Widgets|null
Methods
- __construct() : mixed
- actions() : Actions
- adminPortal() : AdminPortal
- apiKeys() : ApiKeys
- auditLogs() : AuditLogs
- authorization() : Authorization
- connect() : Connect
- directorySync() : DirectorySync
- events() : Events
- featureFlags() : FeatureFlags
- getApiKey() : string|null
- getClientId() : string|null
- groups() : Groups
- multiFactorAuth() : MultiFactorAuth
- organizationDomains() : OrganizationDomains
- organizations() : Organizations
- passwordless() : Passwordless
- pipes() : Pipes
- pkce() : PKCEHelper
- radar() : Radar
- sessionManager() : SessionManager
- setApiKey() : void
- setClientId() : void
- sso() : SSO
- userManagement() : UserManagement
- userManagementOrganizationMembershipGroups() : UserManagementOrganizationMembershipGroups
- vault() : Vault
- webhooks() : Webhooks
- webhookVerification() : WebhookVerification
- widgets() : Widgets
Properties
$actions
private
Actions|null
$actions
= null
$adminPortal
private
AdminPortal|null
$adminPortal
= null
$apiKey
private
static string|null
$apiKey
= null
$apiKeys
private
ApiKeys|null
$apiKeys
= null
$auditLogs
private
AuditLogs|null
$auditLogs
= null
$authorization
private
Authorization|null
$authorization
= null
$clientId
private
static string|null
$clientId
= null
$connect
private
Connect|null
$connect
= null
$directorySync
private
DirectorySync|null
$directorySync
= null
$events
private
Events|null
$events
= null
$featureFlags
private
FeatureFlags|null
$featureFlags
= null
$groups
private
Groups|null
$groups
= null
$httpClient
private
HttpClient|null
$httpClient
= null
$multiFactorAuth
private
MultiFactorAuth|null
$multiFactorAuth
= null
$organizationDomains
private
OrganizationDomains|null
$organizationDomains
= null
$organizations
private
Organizations|null
$organizations
= null
$passwordless
private
Passwordless|null
$passwordless
= null
$pipes
private
Pipes|null
$pipes
= null
$pkce
private
PKCEHelper|null
$pkce
= null
$radar
private
Radar|null
$radar
= null
$sessionManager
private
SessionManager|null
$sessionManager
= null
$sso
private
SSO|null
$sso
= null
$userManagement
private
UserManagement|null
$userManagement
= null
$userManagementOrganizationMembershipGroups
private
UserManagementOrganizationMembershipGroups|null
$userManagementOrganizationMembershipGroups
= null
$vault
private
Vault|null
$vault
= null
$webhooks
private
Webhooks|null
$webhooks
= null
$webhookVerification
private
WebhookVerification|null
$webhookVerification
= null
$widgets
private
Widgets|null
$widgets
= null
Methods
__construct()
public
__construct([string|null $apiKey = null ][, string|null $clientId = null ][, string $baseUrl = 'https://api.workos.com' ][, int $timeout = 60 ][, int $maxRetries = 3 ][, HandlerStack|null $handler = null ][, string|null $userAgent = null ]) : mixed
Parameters
- $apiKey : string|null = null
- $clientId : string|null = null
- $baseUrl : string = 'https://api.workos.com'
- $timeout : int = 60
- $maxRetries : int = 3
- $handler : HandlerStack|null = null
- $userAgent : string|null = null
actions()
public
actions() : Actions
Return values
ActionsadminPortal()
public
adminPortal() : AdminPortal
Return values
AdminPortalapiKeys()
public
apiKeys() : ApiKeys
Return values
ApiKeysauditLogs()
public
auditLogs() : AuditLogs
Return values
AuditLogsauthorization()
public
authorization() : Authorization
Return values
Authorizationconnect()
public
connect() : Connect
Return values
ConnectdirectorySync()
public
directorySync() : DirectorySync
Return values
DirectorySyncevents()
public
events() : Events
Return values
EventsfeatureFlags()
public
featureFlags() : FeatureFlags
Return values
FeatureFlagsgetApiKey()
public
static getApiKey() : string|null
Return values
string|nullgetClientId()
public
static getClientId() : string|null
Return values
string|nullgroups()
public
groups() : Groups
Return values
GroupsmultiFactorAuth()
public
multiFactorAuth() : MultiFactorAuth
Return values
MultiFactorAuthorganizationDomains()
public
organizationDomains() : OrganizationDomains
Return values
OrganizationDomainsorganizations()
public
organizations() : Organizations
Return values
Organizationspasswordless()
public
passwordless() : Passwordless
Return values
Passwordlesspipes()
public
pipes() : Pipes
Return values
Pipespkce()
public
pkce() : PKCEHelper
Return values
PKCEHelperradar()
public
radar() : Radar
Return values
RadarsessionManager()
public
sessionManager() : SessionManager
Return values
SessionManagersetApiKey()
public
static setApiKey(string|null $key) : void
Parameters
- $key : string|null
setClientId()
public
static setClientId(string|null $id) : void
Parameters
- $id : string|null
sso()
public
sso() : SSO
Return values
SSOuserManagement()
public
userManagement() : UserManagement
Return values
UserManagementuserManagementOrganizationMembershipGroups()
public
userManagementOrganizationMembershipGroups() : UserManagementOrganizationMembershipGroups
Return values
UserManagementOrganizationMembershipGroupsvault()
public
vault() : Vault
Return values
Vaultwebhooks()
public
webhooks() : Webhooks
Return values
WebhookswebhookVerification()
public
webhookVerification() : WebhookVerification
Return values
WebhookVerificationwidgets()
public
widgets() : Widgets