AdminPortal
in package
Table of Contents
Properties
Methods
- __construct() : mixed
- generateLink() : PortalLinkResponse
- Generate a Portal Link
Properties
$client read-only
private
HttpClient
$client
Methods
__construct()
public
__construct(HttpClient $client) : mixed
Parameters
- $client : HttpClient
generateLink()
Generate a Portal Link
public
generateLink(string $organization[, string|null $returnUrl = null ][, string|null $successUrl = null ][, GenerateLinkIntent|null $intent = null ][, IntentOptions|null $intentOptions = null ][, array<string|int, string>|null $itContactEmails = null ][, RequestOptions|null $options = null ]) : PortalLinkResponse
Generate a Portal Link scoped to an Organization.
Parameters
- $organization : string
-
An Organization identifier.
- $returnUrl : string|null = null
-
The URL to go to when an admin clicks on your logo in the Admin Portal. If not specified, the return URL configured on the Redirects page will be used.
- $successUrl : string|null = null
-
The URL to redirect the admin to when they finish setup. If not specified, the success URL configured on the Redirects page will be used.
- $intent : GenerateLinkIntent|null = null
-
The intent of the Admin Portal.
sso- Launch Admin Portal for creating SSO connectionsdsync- Launch Admin Portal for creating Directory Sync connectionsaudit_logs- Launch Admin Portal for viewing Audit Logslog_streams- Launch Admin Portal for creating Log Streamsdomain_verification- Launch Admin Portal for Domain Verificationcertificate_renewal- Launch Admin Portal for renewing SAML Certificatesbring_your_own_key- Launch Admin Portal for configuring Bring Your Own Key
- $intentOptions : IntentOptions|null = null
-
Options to configure the Admin Portal based on the intent.
- $itContactEmails : array<string|int, string>|null = null
-
The email addresses of the IT contacts to grant access to the Admin Portal for the given organization. Accepts up to 20 emails.
- $options : RequestOptions|null = null