AdminPortal
in package
Table of Contents
Properties
Methods
- __construct() : mixed
- generateLink() : PortalLinkResponse
- Generate a Portal Link
- revokeLink() : mixed
- Revoke 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 ][, string|null $externalUserId = null ][, GenerateLinkIntent|null $intent = 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 Admin Portal 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 Admin Portal page will be used.
- $externalUserId : string|null = null
-
The ID of the user in your application the link is generated for. The link and any Admin Portal sessions started from it can later be revoked by this ID, for example when that user is deprovisioned from your application.
- $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
- $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
Tags
Return values
PortalLinkResponserevokeLink()
Revoke a Portal Link
public
revokeLink(string $organization, string $externalUserId[, RequestOptions|null $options = null ]) : mixed
Revokes every Portal Link generated for the given organization with the given external_user_id, and immediately ends any Admin Portal sessions that were started from those links. Use this when an admin is deprovisioned from your application: unopened links stop working, and their already-open portal sessions are ended. Only links that were generated with an external_user_id can be revoked, so pass one to generate_link for every admin you may later need to deprovision.
Parameters
- $organization : string
-
An Organization identifier.
- $externalUserId : string
-
The
external_user_idthe Portal Links were generated with for this organization. Every matching link is revoked, along with any Admin Portal sessions started from those links. - $options : RequestOptions|null = null