Source File
admin_portal.go
Belonging Package
github.com/workos/workos-go/v8
// Code generated by oagen. DO NOT EDIT.package workosimport ()// AdminPortalService handles AdminPortal operations.type AdminPortalService struct {client *Client}// AdminPortalGenerateLinkParams contains the parameters for GenerateLink.type AdminPortalGenerateLinkParams struct {// ReturnURL is 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](https://dashboard.workos.com/redirects) page will be used.ReturnURL *string `json:"return_url,omitempty" url:"-"`// SuccessURL is the URL to redirect the admin to when they finish setup. If not specified, the success URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used.SuccessURL *string `json:"success_url,omitempty" url:"-"`// Organization is an [Organization](https://workos.com/docs/reference/organization) identifier.Organization string `json:"organization" url:"-"`// Intent is The intent of the Admin Portal.// - `sso` - Launch Admin Portal for creating SSO connections// - `dsync` - Launch Admin Portal for creating Directory Sync connections// - `audit_logs` - Launch Admin Portal for viewing Audit Logs// - `log_streams` - Launch Admin Portal for creating Log Streams// - `domain_verification` - Launch Admin Portal for Domain Verification// - `certificate_renewal` - Launch Admin Portal for renewing SAML Certificates// - `bring_your_own_key` - Launch Admin Portal for configuring Bring Your Own KeyIntent *GenerateLinkIntent `json:"intent,omitempty" url:"-"`// IntentOptions is options to configure the Admin Portal based on the intent.IntentOptions *IntentOptions `json:"intent_options,omitempty" url:"-"`// ItContactEmails is the email addresses of the IT contacts to grant access to the Admin Portal for the given organization. Accepts up to 20 emails.ItContactEmails []string `json:"it_contact_emails,omitempty" url:"-"`}// GenerateLink generate a Portal Link// Generate a Portal Link scoped to an Organization.func ( *AdminPortalService) ( context.Context, *AdminPortalGenerateLinkParams, ...RequestOption) (*PortalLinkResponse, error) {var PortalLinkResponse, := .client.request(, "POST", "/portal/generate_link", nil, , &, )if != nil {return nil,}return &, nil}
![]() |
The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64) Golds is a Go 101 project developed by Tapir Liu. PR and bug reports are welcome and can be submitted to the issue list. Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds. |