Documentation
¶
Index ¶
- type AddEmailTemplateRequest
- type AddOrgMemberRequest
- type AddTrustedIssuerRequest
- type AddVerifiedOrgDomainRequest
- type AddWebhookRequest
- type AdminLoginRequest
- type AdminMeta
- type AdminSignupRequest
- type AuditLog
- type AuditLogs
- type AuthResponse
- type CheckPermissionsInput
- type CheckPermissionsResponse
- type Client
- type ClientRequest
- type Clients
- type CreateClientRequest
- type CreateClientResponse
- type CreateOrgOIDCConnectionRequest
- type CreateOrgSAMLConnectionRequest
- type CreateOrganizationRequest
- type CreateScimEndpointRequest
- type CreateScimEndpointResponse
- type DeleteEmailTemplateRequest
- type DeleteOrgDomainRequest
- type DeleteUserRequest
- type EmailTemplate
- type EmailTemplates
- type Env
- type Error
- type FgaExpandInput
- type FgaExpandResponse
- type FgaListUsersInput
- type FgaListUsersResponse
- type FgaModel
- type FgaReadTuplesInput
- type FgaRelationInput
- type FgaTuple
- type FgaTupleInput
- type FgaTuples
- type FgaWriteModelInput
- type FgaWriteTuplesInput
- type ForgotPasswordRequest
- type ForgotPasswordResponse
- type GenerateJWTKeysRequest
- type GenerateJWTKeysResponse
- type GetUserRequest
- type InviteMemberRequest
- type InviteMembersResponse
- type ListAuditLogRequest
- type ListClientsRequest
- type ListOrgDomainsRequest
- type ListOrgMembersRequest
- type ListOrganizationsRequest
- type ListPermissionsInput
- type ListPermissionsResponse
- type ListTrustedIssuersRequest
- type ListUsersRequest
- type ListWebhookLogRequest
- type LoginRequest
- type MagicLinkLoginRequest
- type Meta
- type MobileLoginRequest
- type MobileSignUpRequest
- type Mutation
- type OAuthRevokeRequest
- type OrgDomain
- type OrgDomainChallenge
- type OrgDomains
- type OrgMember
- type OrgMembers
- type OrgOIDCConnection
- type OrgOIDCConnectionRequest
- type OrgSAMLConnection
- type OrgSAMLConnectionRequest
- type Organization
- type OrganizationRequest
- type Organizations
- type PaginatedRequest
- type Pagination
- type PaginationRequest
- type Permission
- type PermissionCheckInput
- type PermissionCheckResult
- type Query
- type RemoveOrgMemberRequest
- type RequestOrgDomainRequest
- type ResendOTPRequest
- type ResendVerifyEmailRequest
- type ResetPasswordRequest
- type Response
- type ScimEndpoint
- type ScimEndpointRequest
- type SessionQueryRequest
- type SignUpRequest
- type TestEndpointRequest
- type TestEndpointResponse
- type TrustedIssuer
- type TrustedIssuerRequest
- type TrustedIssuers
- type UpdateAccessRequest
- type UpdateClientRequest
- type UpdateEmailTemplateRequest
- type UpdateEnvRequest
- type UpdateOrgOIDCConnectionRequest
- type UpdateOrgSAMLConnectionRequest
- type UpdateOrganizationRequest
- type UpdateProfileRequest
- type UpdateTrustedIssuerRequest
- type UpdateUserRequest
- type UpdateWebhookRequest
- type User
- type UserOrganization
- type UserOrganizations
- type UserOrganizationsRequest
- type Users
- type ValidateJWTTokenRequest
- type ValidateJWTTokenResponse
- type ValidateSessionRequest
- type ValidateSessionResponse
- type VerificationRequest
- type VerificationRequests
- type VerifyEmailRequest
- type VerifyOTPRequest
- type VerifyOrgDomainRequest
- type WebauthnCredentialInfo
- type WebauthnLoginOptionsResponse
- type WebauthnLoginVerifyRequest
- type WebauthnRegistrationOptionsResponse
- type WebauthnRegistrationVerifyRequest
- type Webhook
- type WebhookLog
- type WebhookLogs
- type WebhookRequest
- type Webhooks
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddEmailTemplateRequest ¶
type AddOrgMemberRequest ¶
type AddTrustedIssuerRequest ¶
type AddTrustedIssuerRequest struct {
ServiceAccountID string `json:"service_account_id"`
Name string `json:"name"`
IssuerURL string `json:"issuer_url"`
KeySourceType string `json:"key_source_type"`
JwksURL *string `json:"jwks_url,omitempty"`
ExpectedAud string `json:"expected_aud"`
SubjectClaim *string `json:"subject_claim,omitempty"`
AllowedSubjects *string `json:"allowed_subjects,omitempty"`
IssuerType string `json:"issuer_type"`
SpiffeRefreshHintSeconds *int64 `json:"spiffe_refresh_hint_seconds,omitempty"`
EnableTokenReview *bool `json:"enable_token_review,omitempty"`
KubernetesAPIServerURL *string `json:"kubernetes_api_server_url,omitempty"`
}
type AddWebhookRequest ¶
type AdminLoginRequest ¶
type AdminLoginRequest struct {
AdminSecret string `json:"admin_secret"`
}
type AdminSignupRequest ¶
type AdminSignupRequest struct {
AdminSecret string `json:"admin_secret"`
}
type AuditLog ¶
type AuditLog struct {
ID string `json:"id"`
ActorID *string `json:"actor_id,omitempty"`
ActorType *string `json:"actor_type,omitempty"`
ActorEmail *string `json:"actor_email,omitempty"`
Action *string `json:"action,omitempty"`
ResourceType *string `json:"resource_type,omitempty"`
ResourceID *string `json:"resource_id,omitempty"`
IPAddress *string `json:"ip_address,omitempty"`
UserAgent *string `json:"user_agent,omitempty"`
Metadata *string `json:"metadata,omitempty"`
CreatedAt *int64 `json:"created_at,omitempty"`
}
type AuditLogs ¶
type AuditLogs struct {
Pagination *Pagination `json:"pagination"`
AuditLogs []*AuditLog `json:"audit_logs"`
}
type AuthResponse ¶
type AuthResponse struct {
Message string `json:"message"`
ShouldShowEmailOtpScreen *bool `json:"should_show_email_otp_screen,omitempty"`
ShouldShowMobileOtpScreen *bool `json:"should_show_mobile_otp_screen,omitempty"`
ShouldShowTotpScreen *bool `json:"should_show_totp_screen,omitempty"`
ShouldOfferWebauthnMfaVerify *bool `json:"should_offer_webauthn_mfa_verify,omitempty"`
ShouldOfferMfaSetup *bool `json:"should_offer_mfa_setup,omitempty"`
AccessToken *string `json:"access_token,omitempty"`
IDToken *string `json:"id_token,omitempty"`
RefreshToken *string `json:"refresh_token,omitempty"`
ExpiresIn *int64 `json:"expires_in,omitempty"`
User *User `json:"user,omitempty"`
AuthenticatorScannerImage *string `json:"authenticator_scanner_image,omitempty"`
AuthenticatorSecret *string `json:"authenticator_secret,omitempty"`
AuthenticatorRecoveryCodes []*string `json:"authenticator_recovery_codes,omitempty"`
}
type CheckPermissionsInput ¶
type CheckPermissionsInput struct {
Checks []*PermissionCheckInput `json:"checks"`
User *string `json:"user,omitempty"`
}
type CheckPermissionsResponse ¶
type CheckPermissionsResponse struct {
Results []*PermissionCheckResult `json:"results"`
}
type Client ¶
type Client struct {
ID string `json:"id"`
ClientID string `json:"client_id"`
Name string `json:"name"`
Description *string `json:"description,omitempty"`
AllowedScopes []string `json:"allowed_scopes"`
IsActive bool `json:"is_active"`
CreatedAt *int64 `json:"created_at,omitempty"`
UpdatedAt *int64 `json:"updated_at,omitempty"`
}
type ClientRequest ¶
type ClientRequest struct {
ID string `json:"id"`
}
type Clients ¶
type Clients struct {
Pagination *Pagination `json:"pagination"`
Clients []*Client `json:"clients"`
}
type CreateClientRequest ¶
type CreateClientResponse ¶
type CreateOrgOIDCConnectionRequest ¶
type CreateOrgOIDCConnectionRequest struct {
OrgID string `json:"org_id"`
Name string `json:"name"`
IssuerURL string `json:"issuer_url"`
ClientID string `json:"client_id"`
ClientSecret string `json:"client_secret"`
Scopes *string `json:"scopes,omitempty"`
RedirectURI *string `json:"redirect_uri,omitempty"`
}
type CreateOrgSAMLConnectionRequest ¶
type CreateOrgSAMLConnectionRequest struct {
OrgID string `json:"org_id"`
Name string `json:"name"`
IdpEntityID string `json:"idp_entity_id"`
IdpSsoURL string `json:"idp_sso_url"`
IdpCertificate string `json:"idp_certificate"`
SpEntityID *string `json:"sp_entity_id,omitempty"`
AcsURL *string `json:"acs_url,omitempty"`
AttributeMapping *string `json:"attribute_mapping,omitempty"`
AllowIdpInitiated *bool `json:"allow_idp_initiated,omitempty"`
}
type CreateScimEndpointRequest ¶
type CreateScimEndpointRequest struct {
OrgID string `json:"org_id"`
}
type CreateScimEndpointResponse ¶
type CreateScimEndpointResponse struct {
ScimEndpoint *ScimEndpoint `json:"scim_endpoint"`
Token string `json:"token"`
}
type DeleteEmailTemplateRequest ¶
type DeleteEmailTemplateRequest struct {
ID string `json:"id"`
}
type DeleteOrgDomainRequest ¶
type DeleteOrgDomainRequest struct {
Domain string `json:"domain"`
}
type DeleteUserRequest ¶
type DeleteUserRequest struct {
Email string `json:"email"`
}
type EmailTemplate ¶
type EmailTemplates ¶
type EmailTemplates struct {
Pagination *Pagination `json:"pagination"`
EmailTemplates []*EmailTemplate `json:"email_templates"`
}
type Env ¶
type Env struct {
AccessTokenExpiryTime *string `json:"ACCESS_TOKEN_EXPIRY_TIME,omitempty"`
AdminSecret *string `json:"ADMIN_SECRET,omitempty"`
DatabaseName *string `json:"DATABASE_NAME,omitempty"`
DatabaseURL *string `json:"DATABASE_URL,omitempty"`
DatabaseType *string `json:"DATABASE_TYPE,omitempty"`
DatabaseUsername *string `json:"DATABASE_USERNAME,omitempty"`
DatabasePassword *string `json:"DATABASE_PASSWORD,omitempty"`
DatabaseHost *string `json:"DATABASE_HOST,omitempty"`
DatabasePort *string `json:"DATABASE_PORT,omitempty"`
ClientID string `json:"CLIENT_ID"`
ClientSecret string `json:"CLIENT_SECRET"`
CustomAccessTokenScript *string `json:"CUSTOM_ACCESS_TOKEN_SCRIPT,omitempty"`
SMTPHost *string `json:"SMTP_HOST,omitempty"`
SMTPPort *string `json:"SMTP_PORT,omitempty"`
SMTPUsername *string `json:"SMTP_USERNAME,omitempty"`
SMTPPassword *string `json:"SMTP_PASSWORD,omitempty"`
SMTPLocalName *string `json:"SMTP_LOCAL_NAME,omitempty"`
SenderEmail *string `json:"SENDER_EMAIL,omitempty"`
SenderName *string `json:"SENDER_NAME,omitempty"`
JwtType *string `json:"JWT_TYPE,omitempty"`
JwtSecret *string `json:"JWT_SECRET,omitempty"`
JwtPrivateKey *string `json:"JWT_PRIVATE_KEY,omitempty"`
JwtPublicKey *string `json:"JWT_PUBLIC_KEY,omitempty"`
AllowedOrigins []string `json:"ALLOWED_ORIGINS,omitempty"`
AppURL *string `json:"APP_URL,omitempty"`
RedisURL *string `json:"REDIS_URL,omitempty"`
ResetPasswordURL *string `json:"RESET_PASSWORD_URL,omitempty"`
DisableEmailVerification bool `json:"DISABLE_EMAIL_VERIFICATION"`
DisableBasicAuthentication bool `json:"DISABLE_BASIC_AUTHENTICATION"`
DisableMobileBasicAuthentication bool `json:"DISABLE_MOBILE_BASIC_AUTHENTICATION"`
DisableMagicLinkLogin bool `json:"DISABLE_MAGIC_LINK_LOGIN"`
DisableLoginPage bool `json:"DISABLE_LOGIN_PAGE"`
DisableSignUp bool `json:"DISABLE_SIGN_UP"`
DisableRedisForEnv bool `json:"DISABLE_REDIS_FOR_ENV"`
DisableStrongPassword bool `json:"DISABLE_STRONG_PASSWORD"`
DisableMultiFactorAuthentication bool `json:"DISABLE_MULTI_FACTOR_AUTHENTICATION"`
EnforceMultiFactorAuthentication bool `json:"ENFORCE_MULTI_FACTOR_AUTHENTICATION"`
Roles []string `json:"ROLES,omitempty"`
ProtectedRoles []string `json:"PROTECTED_ROLES,omitempty"`
DefaultRoles []string `json:"DEFAULT_ROLES,omitempty"`
JwtRoleClaim *string `json:"JWT_ROLE_CLAIM,omitempty"`
GoogleClientID *string `json:"GOOGLE_CLIENT_ID,omitempty"`
GoogleClientSecret *string `json:"GOOGLE_CLIENT_SECRET,omitempty"`
GithubClientID *string `json:"GITHUB_CLIENT_ID,omitempty"`
GithubClientSecret *string `json:"GITHUB_CLIENT_SECRET,omitempty"`
FacebookClientID *string `json:"FACEBOOK_CLIENT_ID,omitempty"`
FacebookClientSecret *string `json:"FACEBOOK_CLIENT_SECRET,omitempty"`
LinkedinClientID *string `json:"LINKEDIN_CLIENT_ID,omitempty"`
LinkedinClientSecret *string `json:"LINKEDIN_CLIENT_SECRET,omitempty"`
AppleClientID *string `json:"APPLE_CLIENT_ID,omitempty"`
AppleClientSecret *string `json:"APPLE_CLIENT_SECRET,omitempty"`
DiscordClientID *string `json:"DISCORD_CLIENT_ID,omitempty"`
DiscordClientSecret *string `json:"DISCORD_CLIENT_SECRET,omitempty"`
TwitterClientID *string `json:"TWITTER_CLIENT_ID,omitempty"`
TwitterClientSecret *string `json:"TWITTER_CLIENT_SECRET,omitempty"`
MicrosoftClientID *string `json:"MICROSOFT_CLIENT_ID,omitempty"`
MicrosoftClientSecret *string `json:"MICROSOFT_CLIENT_SECRET,omitempty"`
MicrosoftActiveDirectoryTenantID *string `json:"MICROSOFT_ACTIVE_DIRECTORY_TENANT_ID,omitempty"`
TwitchClientID *string `json:"TWITCH_CLIENT_ID,omitempty"`
TwitchClientSecret *string `json:"TWITCH_CLIENT_SECRET,omitempty"`
RobloxClientID *string `json:"ROBLOX_CLIENT_ID,omitempty"`
RobloxClientSecret *string `json:"ROBLOX_CLIENT_SECRET,omitempty"`
OrganizationName *string `json:"ORGANIZATION_NAME,omitempty"`
OrganizationLogo *string `json:"ORGANIZATION_LOGO,omitempty"`
AppCookieSecure bool `json:"APP_COOKIE_SECURE"`
AdminCookieSecure bool `json:"ADMIN_COOKIE_SECURE"`
DefaultAuthorizeResponseType *string `json:"DEFAULT_AUTHORIZE_RESPONSE_TYPE,omitempty"`
DefaultAuthorizeResponseMode *string `json:"DEFAULT_AUTHORIZE_RESPONSE_MODE,omitempty"`
DisablePlayground bool `json:"DISABLE_PLAYGROUND"`
DisableMailOtpLogin bool `json:"DISABLE_MAIL_OTP_LOGIN"`
DisableTotpLogin bool `json:"DISABLE_TOTP_LOGIN"`
}
type FgaExpandInput ¶
type FgaExpandResponse ¶
type FgaExpandResponse struct {
Tree string `json:"tree"`
}
type FgaListUsersInput ¶
type FgaListUsersResponse ¶
type FgaListUsersResponse struct {
Users []string `json:"users"`
}
type FgaReadTuplesInput ¶
type FgaRelationInput ¶
type FgaTupleInput ¶
type FgaWriteModelInput ¶
type FgaWriteModelInput struct {
Dsl string `json:"dsl"`
}
type FgaWriteTuplesInput ¶
type FgaWriteTuplesInput struct {
Tuples []*FgaTupleInput `json:"tuples"`
}
type ForgotPasswordRequest ¶
type ForgotPasswordResponse ¶
type GenerateJWTKeysRequest ¶
type GenerateJWTKeysRequest struct {
Type string `json:"type"`
}
type GenerateJWTKeysResponse ¶
type GetUserRequest ¶
type InviteMemberRequest ¶
type InviteMembersResponse ¶
type ListAuditLogRequest ¶
type ListAuditLogRequest struct {
Pagination *PaginationRequest `json:"pagination,omitempty"`
Action *string `json:"action,omitempty"`
ActorID *string `json:"actor_id,omitempty"`
ResourceType *string `json:"resource_type,omitempty"`
ResourceID *string `json:"resource_id,omitempty"`
FromTimestamp *int64 `json:"from_timestamp,omitempty"`
ToTimestamp *int64 `json:"to_timestamp,omitempty"`
}
type ListClientsRequest ¶
type ListClientsRequest struct {
Pagination *PaginatedRequest `json:"pagination,omitempty"`
}
type ListOrgDomainsRequest ¶
type ListOrgDomainsRequest struct {
OrgID string `json:"org_id"`
Pagination *PaginatedRequest `json:"pagination,omitempty"`
}
type ListOrgMembersRequest ¶
type ListOrgMembersRequest struct {
OrgID string `json:"org_id"`
Pagination *PaginatedRequest `json:"pagination,omitempty"`
}
type ListOrganizationsRequest ¶
type ListOrganizationsRequest struct {
Pagination *PaginatedRequest `json:"pagination,omitempty"`
}
type ListPermissionsInput ¶
type ListPermissionsResponse ¶
type ListPermissionsResponse struct {
Objects []string `json:"objects"`
Permissions []*Permission `json:"permissions"`
Truncated bool `json:"truncated"`
}
type ListTrustedIssuersRequest ¶
type ListTrustedIssuersRequest struct {
ServiceAccountID *string `json:"service_account_id,omitempty"`
Pagination *PaginatedRequest `json:"pagination,omitempty"`
}
type ListUsersRequest ¶
type ListUsersRequest struct {
Pagination *PaginationRequest `json:"pagination,omitempty"`
Query *string `json:"query,omitempty"`
}
type ListWebhookLogRequest ¶
type ListWebhookLogRequest struct {
Pagination *PaginationRequest `json:"pagination,omitempty"`
WebhookID *string `json:"webhook_id,omitempty"`
}
type LoginRequest ¶
type MagicLinkLoginRequest ¶
type Meta ¶
type Meta struct {
Version string `json:"version"`
ClientID string `json:"client_id"`
IsGoogleLoginEnabled bool `json:"is_google_login_enabled"`
IsFacebookLoginEnabled bool `json:"is_facebook_login_enabled"`
IsGithubLoginEnabled bool `json:"is_github_login_enabled"`
IsLinkedinLoginEnabled bool `json:"is_linkedin_login_enabled"`
IsAppleLoginEnabled bool `json:"is_apple_login_enabled"`
IsDiscordLoginEnabled bool `json:"is_discord_login_enabled"`
IsTwitterLoginEnabled bool `json:"is_twitter_login_enabled"`
IsMicrosoftLoginEnabled bool `json:"is_microsoft_login_enabled"`
IsTwitchLoginEnabled bool `json:"is_twitch_login_enabled"`
IsRobloxLoginEnabled bool `json:"is_roblox_login_enabled"`
IsEmailVerificationEnabled bool `json:"is_email_verification_enabled"`
IsBasicAuthenticationEnabled bool `json:"is_basic_authentication_enabled"`
IsMagicLinkLoginEnabled bool `json:"is_magic_link_login_enabled"`
IsSignUpEnabled bool `json:"is_sign_up_enabled"`
IsStrongPasswordEnabled bool `json:"is_strong_password_enabled"`
IsMultiFactorAuthEnabled bool `json:"is_multi_factor_auth_enabled"`
IsMobileBasicAuthenticationEnabled bool `json:"is_mobile_basic_authentication_enabled"`
IsPhoneVerificationEnabled bool `json:"is_phone_verification_enabled"`
IsOrgDiscoveryEnabled bool `json:"is_org_discovery_enabled"`
IsTotpMfaEnabled bool `json:"is_totp_mfa_enabled"`
IsEmailOtpMfaEnabled bool `json:"is_email_otp_mfa_enabled"`
IsSmsOtpMfaEnabled bool `json:"is_sms_otp_mfa_enabled"`
IsWebauthnEnabled bool `json:"is_webauthn_enabled"`
IsMfaEnforced bool `json:"is_mfa_enforced"`
}
type MobileLoginRequest ¶
type MobileSignUpRequest ¶
type MobileSignUpRequest struct {
Email *string `json:"email,omitempty"`
GivenName *string `json:"given_name,omitempty"`
FamilyName *string `json:"family_name,omitempty"`
MiddleName *string `json:"middle_name,omitempty"`
Nickname *string `json:"nickname,omitempty"`
Gender *string `json:"gender,omitempty"`
Birthdate *string `json:"birthdate,omitempty"`
PhoneNumber string `json:"phone_number"`
Picture *string `json:"picture,omitempty"`
Password string `json:"password"`
ConfirmPassword string `json:"confirm_password"`
Roles []string `json:"roles,omitempty"`
Scope []string `json:"scope,omitempty"`
RedirectURI *string `json:"redirect_uri,omitempty"`
IsMultiFactorAuthEnabled *bool `json:"is_multi_factor_auth_enabled,omitempty"`
State *string `json:"state,omitempty"`
AppData map[string]any `json:"app_data,omitempty"`
}
type OAuthRevokeRequest ¶
type OAuthRevokeRequest struct {
RefreshToken string `json:"refresh_token"`
}
type OrgDomainChallenge ¶
type OrgDomains ¶
type OrgDomains struct {
Pagination *Pagination `json:"pagination"`
OrgDomains []*OrgDomain `json:"org_domains"`
}
type OrgMember ¶
type OrgMember struct {
ID string `json:"id"`
OrgID string `json:"org_id"`
UserID string `json:"user_id"`
Email *string `json:"email,omitempty"`
GivenName *string `json:"given_name,omitempty"`
FamilyName *string `json:"family_name,omitempty"`
Roles []string `json:"roles"`
CreatedAt *int64 `json:"created_at,omitempty"`
UpdatedAt *int64 `json:"updated_at,omitempty"`
}
type OrgMembers ¶
type OrgMembers struct {
Pagination *Pagination `json:"pagination"`
OrgMembers []*OrgMember `json:"org_members"`
}
type OrgOIDCConnection ¶
type OrgOIDCConnection struct {
ID string `json:"id"`
OrgID string `json:"org_id"`
Name string `json:"name"`
IssuerURL string `json:"issuer_url"`
SsoClientID string `json:"sso_client_id"`
Scopes *string `json:"scopes,omitempty"`
RedirectURI *string `json:"redirect_uri,omitempty"`
IsActive bool `json:"is_active"`
CreatedAt *int64 `json:"created_at,omitempty"`
UpdatedAt *int64 `json:"updated_at,omitempty"`
}
type OrgSAMLConnection ¶
type OrgSAMLConnection struct {
ID string `json:"id"`
OrgID string `json:"org_id"`
Name string `json:"name"`
IdpEntityID string `json:"idp_entity_id"`
IdpSsoURL *string `json:"idp_sso_url,omitempty"`
SpEntityID *string `json:"sp_entity_id,omitempty"`
AcsURL *string `json:"acs_url,omitempty"`
AttributeMapping *string `json:"attribute_mapping,omitempty"`
AllowIdpInitiated bool `json:"allow_idp_initiated"`
IsActive bool `json:"is_active"`
CreatedAt *int64 `json:"created_at,omitempty"`
UpdatedAt *int64 `json:"updated_at,omitempty"`
}
type Organization ¶
type OrganizationRequest ¶
type OrganizationRequest struct {
ID string `json:"id"`
}
type Organizations ¶
type Organizations struct {
Pagination *Pagination `json:"pagination"`
Organizations []*Organization `json:"organizations"`
}
type PaginatedRequest ¶
type PaginatedRequest struct {
Pagination *PaginationRequest `json:"pagination,omitempty"`
}
type Pagination ¶
type PaginationRequest ¶
type Permission ¶
type PermissionCheckInput ¶
type PermissionCheckInput struct {
Relation string `json:"relation"`
Object string `json:"object"`
ContextualTuples []*FgaTupleInput `json:"contextual_tuples,omitempty"`
}
type PermissionCheckResult ¶
type RemoveOrgMemberRequest ¶
type RequestOrgDomainRequest ¶
type ResendOTPRequest ¶
type ResetPasswordRequest ¶
type ScimEndpoint ¶
type ScimEndpointRequest ¶
type ScimEndpointRequest struct {
OrgID string `json:"org_id"`
}
type SessionQueryRequest ¶
type SessionQueryRequest struct {
Roles []string `json:"roles,omitempty"`
Scope []string `json:"scope,omitempty"`
State *string `json:"state,omitempty"`
RequiredRelations []*FgaRelationInput `json:"required_relations,omitempty"`
}
type SignUpRequest ¶
type SignUpRequest struct {
Email *string `json:"email,omitempty"`
GivenName *string `json:"given_name,omitempty"`
FamilyName *string `json:"family_name,omitempty"`
MiddleName *string `json:"middle_name,omitempty"`
Nickname *string `json:"nickname,omitempty"`
Gender *string `json:"gender,omitempty"`
Birthdate *string `json:"birthdate,omitempty"`
PhoneNumber *string `json:"phone_number,omitempty"`
Picture *string `json:"picture,omitempty"`
Password string `json:"password"`
ConfirmPassword string `json:"confirm_password"`
Roles []string `json:"roles,omitempty"`
Scope []string `json:"scope,omitempty"`
RedirectURI *string `json:"redirect_uri,omitempty"`
IsMultiFactorAuthEnabled *bool `json:"is_multi_factor_auth_enabled,omitempty"`
State *string `json:"state,omitempty"`
AppData map[string]any `json:"app_data,omitempty"`
}
type TestEndpointRequest ¶
type TestEndpointResponse ¶
type TrustedIssuer ¶
type TrustedIssuer struct {
ID string `json:"id"`
ServiceAccountID string `json:"service_account_id"`
Name string `json:"name"`
IssuerURL string `json:"issuer_url"`
KeySourceType string `json:"key_source_type"`
JwksURL *string `json:"jwks_url,omitempty"`
ExpectedAud string `json:"expected_aud"`
SubjectClaim string `json:"subject_claim"`
AllowedSubjects *string `json:"allowed_subjects,omitempty"`
IssuerType string `json:"issuer_type"`
IsActive bool `json:"is_active"`
SpiffeRefreshHintSeconds *int64 `json:"spiffe_refresh_hint_seconds,omitempty"`
EnableTokenReview bool `json:"enable_token_review"`
KubernetesAPIServerURL *string `json:"kubernetes_api_server_url,omitempty"`
CreatedAt *int64 `json:"created_at,omitempty"`
UpdatedAt *int64 `json:"updated_at,omitempty"`
}
type TrustedIssuerRequest ¶
type TrustedIssuerRequest struct {
ID string `json:"id"`
}
type TrustedIssuers ¶
type TrustedIssuers struct {
Pagination *Pagination `json:"pagination"`
TrustedIssuers []*TrustedIssuer `json:"trusted_issuers"`
}
type UpdateAccessRequest ¶
type UpdateAccessRequest struct {
UserID string `json:"user_id"`
}
type UpdateClientRequest ¶
type UpdateEnvRequest ¶
type UpdateEnvRequest struct {
AccessTokenExpiryTime *string `json:"ACCESS_TOKEN_EXPIRY_TIME,omitempty"`
AdminSecret *string `json:"ADMIN_SECRET,omitempty"`
CustomAccessTokenScript *string `json:"CUSTOM_ACCESS_TOKEN_SCRIPT,omitempty"`
OldAdminSecret *string `json:"OLD_ADMIN_SECRET,omitempty"`
SMTPHost *string `json:"SMTP_HOST,omitempty"`
SMTPPort *string `json:"SMTP_PORT,omitempty"`
SMTPUsername *string `json:"SMTP_USERNAME,omitempty"`
SMTPPassword *string `json:"SMTP_PASSWORD,omitempty"`
SMTPLocalName *string `json:"SMTP_LOCAL_NAME,omitempty"`
SenderEmail *string `json:"SENDER_EMAIL,omitempty"`
SenderName *string `json:"SENDER_NAME,omitempty"`
JwtType *string `json:"JWT_TYPE,omitempty"`
JwtSecret *string `json:"JWT_SECRET,omitempty"`
JwtPrivateKey *string `json:"JWT_PRIVATE_KEY,omitempty"`
JwtPublicKey *string `json:"JWT_PUBLIC_KEY,omitempty"`
AllowedOrigins []string `json:"ALLOWED_ORIGINS,omitempty"`
AppURL *string `json:"APP_URL,omitempty"`
ResetPasswordURL *string `json:"RESET_PASSWORD_URL,omitempty"`
AppCookieSecure *bool `json:"APP_COOKIE_SECURE,omitempty"`
AdminCookieSecure *bool `json:"ADMIN_COOKIE_SECURE,omitempty"`
DisableEmailVerification *bool `json:"DISABLE_EMAIL_VERIFICATION,omitempty"`
DisableBasicAuthentication *bool `json:"DISABLE_BASIC_AUTHENTICATION,omitempty"`
DisableMobileBasicAuthentication *bool `json:"DISABLE_MOBILE_BASIC_AUTHENTICATION,omitempty"`
DisableMagicLinkLogin *bool `json:"DISABLE_MAGIC_LINK_LOGIN,omitempty"`
DisableLoginPage *bool `json:"DISABLE_LOGIN_PAGE,omitempty"`
DisableSignUp *bool `json:"DISABLE_SIGN_UP,omitempty"`
DisableRedisForEnv *bool `json:"DISABLE_REDIS_FOR_ENV,omitempty"`
DisableStrongPassword *bool `json:"DISABLE_STRONG_PASSWORD,omitempty"`
DisableMultiFactorAuthentication *bool `json:"DISABLE_MULTI_FACTOR_AUTHENTICATION,omitempty"`
EnforceMultiFactorAuthentication *bool `json:"ENFORCE_MULTI_FACTOR_AUTHENTICATION,omitempty"`
Roles []string `json:"ROLES,omitempty"`
ProtectedRoles []string `json:"PROTECTED_ROLES,omitempty"`
DefaultRoles []string `json:"DEFAULT_ROLES,omitempty"`
JwtRoleClaim *string `json:"JWT_ROLE_CLAIM,omitempty"`
GoogleClientID *string `json:"GOOGLE_CLIENT_ID,omitempty"`
GoogleClientSecret *string `json:"GOOGLE_CLIENT_SECRET,omitempty"`
GithubClientID *string `json:"GITHUB_CLIENT_ID,omitempty"`
GithubClientSecret *string `json:"GITHUB_CLIENT_SECRET,omitempty"`
FacebookClientID *string `json:"FACEBOOK_CLIENT_ID,omitempty"`
FacebookClientSecret *string `json:"FACEBOOK_CLIENT_SECRET,omitempty"`
LinkedinClientID *string `json:"LINKEDIN_CLIENT_ID,omitempty"`
LinkedinClientSecret *string `json:"LINKEDIN_CLIENT_SECRET,omitempty"`
AppleClientID *string `json:"APPLE_CLIENT_ID,omitempty"`
AppleClientSecret *string `json:"APPLE_CLIENT_SECRET,omitempty"`
DiscordClientID *string `json:"DISCORD_CLIENT_ID,omitempty"`
DiscordClientSecret *string `json:"DISCORD_CLIENT_SECRET,omitempty"`
TwitterClientID *string `json:"TWITTER_CLIENT_ID,omitempty"`
TwitterClientSecret *string `json:"TWITTER_CLIENT_SECRET,omitempty"`
MicrosoftClientID *string `json:"MICROSOFT_CLIENT_ID,omitempty"`
MicrosoftClientSecret *string `json:"MICROSOFT_CLIENT_SECRET,omitempty"`
MicrosoftActiveDirectoryTenantID *string `json:"MICROSOFT_ACTIVE_DIRECTORY_TENANT_ID,omitempty"`
TwitchClientID *string `json:"TWITCH_CLIENT_ID,omitempty"`
TwitchClientSecret *string `json:"TWITCH_CLIENT_SECRET,omitempty"`
RobloxClientID *string `json:"ROBLOX_CLIENT_ID,omitempty"`
RobloxClientSecret *string `json:"ROBLOX_CLIENT_SECRET,omitempty"`
OrganizationName *string `json:"ORGANIZATION_NAME,omitempty"`
OrganizationLogo *string `json:"ORGANIZATION_LOGO,omitempty"`
DefaultAuthorizeResponseType *string `json:"DEFAULT_AUTHORIZE_RESPONSE_TYPE,omitempty"`
DefaultAuthorizeResponseMode *string `json:"DEFAULT_AUTHORIZE_RESPONSE_MODE,omitempty"`
DisablePlayground *bool `json:"DISABLE_PLAYGROUND,omitempty"`
DisableMailOtpLogin *bool `json:"DISABLE_MAIL_OTP_LOGIN,omitempty"`
DisableTotpLogin *bool `json:"DISABLE_TOTP_LOGIN,omitempty"`
}
type UpdateOrgOIDCConnectionRequest ¶
type UpdateOrgOIDCConnectionRequest struct {
ID string `json:"id"`
Name *string `json:"name,omitempty"`
IssuerURL *string `json:"issuer_url,omitempty"`
ClientID *string `json:"client_id,omitempty"`
ClientSecret *string `json:"client_secret,omitempty"`
Scopes *string `json:"scopes,omitempty"`
RedirectURI *string `json:"redirect_uri,omitempty"`
IsActive *bool `json:"is_active,omitempty"`
}
type UpdateOrgSAMLConnectionRequest ¶
type UpdateOrgSAMLConnectionRequest struct {
ID string `json:"id"`
Name *string `json:"name,omitempty"`
IdpEntityID *string `json:"idp_entity_id,omitempty"`
IdpSsoURL *string `json:"idp_sso_url,omitempty"`
IdpCertificate *string `json:"idp_certificate,omitempty"`
SpEntityID *string `json:"sp_entity_id,omitempty"`
AcsURL *string `json:"acs_url,omitempty"`
AttributeMapping *string `json:"attribute_mapping,omitempty"`
AllowIdpInitiated *bool `json:"allow_idp_initiated,omitempty"`
IsActive *bool `json:"is_active,omitempty"`
}
type UpdateProfileRequest ¶
type UpdateProfileRequest struct {
OldPassword *string `json:"old_password,omitempty"`
NewPassword *string `json:"new_password,omitempty"`
ConfirmNewPassword *string `json:"confirm_new_password,omitempty"`
Email *string `json:"email,omitempty"`
GivenName *string `json:"given_name,omitempty"`
FamilyName *string `json:"family_name,omitempty"`
MiddleName *string `json:"middle_name,omitempty"`
Nickname *string `json:"nickname,omitempty"`
Gender *string `json:"gender,omitempty"`
Birthdate *string `json:"birthdate,omitempty"`
PhoneNumber *string `json:"phone_number,omitempty"`
Picture *string `json:"picture,omitempty"`
IsMultiFactorAuthEnabled *bool `json:"is_multi_factor_auth_enabled,omitempty"`
AppData map[string]any `json:"app_data,omitempty"`
}
type UpdateTrustedIssuerRequest ¶
type UpdateTrustedIssuerRequest struct {
ID string `json:"id"`
Name *string `json:"name,omitempty"`
JwksURL *string `json:"jwks_url,omitempty"`
ExpectedAud *string `json:"expected_aud,omitempty"`
AllowedSubjects *string `json:"allowed_subjects,omitempty"`
IsActive *bool `json:"is_active,omitempty"`
SpiffeRefreshHintSeconds *int64 `json:"spiffe_refresh_hint_seconds,omitempty"`
EnableTokenReview *bool `json:"enable_token_review,omitempty"`
KubernetesAPIServerURL *string `json:"kubernetes_api_server_url,omitempty"`
}
type UpdateUserRequest ¶
type UpdateUserRequest struct {
ID string `json:"id"`
Email *string `json:"email,omitempty"`
EmailVerified *bool `json:"email_verified,omitempty"`
GivenName *string `json:"given_name,omitempty"`
FamilyName *string `json:"family_name,omitempty"`
MiddleName *string `json:"middle_name,omitempty"`
Nickname *string `json:"nickname,omitempty"`
Gender *string `json:"gender,omitempty"`
Birthdate *string `json:"birthdate,omitempty"`
PhoneNumber *string `json:"phone_number,omitempty"`
PhoneNumberVerified *bool `json:"phone_number_verified,omitempty"`
Picture *string `json:"picture,omitempty"`
Roles []*string `json:"roles,omitempty"`
IsMultiFactorAuthEnabled *bool `json:"is_multi_factor_auth_enabled,omitempty"`
AppData map[string]any `json:"app_data,omitempty"`
}
type UpdateWebhookRequest ¶
type UpdateWebhookRequest struct {
ID string `json:"id"`
EventName *string `json:"event_name,omitempty"`
EventDescription *string `json:"event_description,omitempty"`
Endpoint *string `json:"endpoint,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
Headers map[string]any `json:"headers,omitempty"`
}
type User ¶
type User struct {
ID string `json:"id"`
Email *string `json:"email,omitempty"`
EmailVerified bool `json:"email_verified"`
SignupMethods string `json:"signup_methods"`
GivenName *string `json:"given_name,omitempty"`
FamilyName *string `json:"family_name,omitempty"`
MiddleName *string `json:"middle_name,omitempty"`
Nickname *string `json:"nickname,omitempty"`
PreferredUsername *string `json:"preferred_username,omitempty"`
Gender *string `json:"gender,omitempty"`
Birthdate *string `json:"birthdate,omitempty"`
PhoneNumber *string `json:"phone_number,omitempty"`
PhoneNumberVerified bool `json:"phone_number_verified"`
Picture *string `json:"picture,omitempty"`
Roles []string `json:"roles"`
CreatedAt *int64 `json:"created_at,omitempty"`
UpdatedAt *int64 `json:"updated_at,omitempty"`
RevokedTimestamp *int64 `json:"revoked_timestamp,omitempty"`
IsMultiFactorAuthEnabled *bool `json:"is_multi_factor_auth_enabled,omitempty"`
HasSkippedMfaSetupAt *int64 `json:"has_skipped_mfa_setup_at,omitempty"`
AppData map[string]any `json:"app_data,omitempty"`
}
type UserOrganization ¶
type UserOrganization struct {
Organization *Organization `json:"organization"`
Roles []string `json:"roles"`
}
type UserOrganizations ¶
type UserOrganizations struct {
Pagination *Pagination `json:"pagination"`
UserOrganizations []*UserOrganization `json:"user_organizations"`
}
type UserOrganizationsRequest ¶
type UserOrganizationsRequest struct {
UserID string `json:"user_id"`
Pagination *PaginationRequest `json:"pagination,omitempty"`
}
type Users ¶
type Users struct {
Pagination *Pagination `json:"pagination"`
Users []*User `json:"users"`
}
type ValidateJWTTokenRequest ¶
type ValidateJWTTokenRequest struct {
TokenType string `json:"token_type"`
Token string `json:"token"`
Roles []string `json:"roles,omitempty"`
RequiredRelations []*FgaRelationInput `json:"required_relations,omitempty"`
}
type ValidateSessionRequest ¶
type ValidateSessionRequest struct {
Cookie string `json:"cookie"`
Roles []string `json:"roles,omitempty"`
RequiredRelations []*FgaRelationInput `json:"required_relations,omitempty"`
}
type ValidateSessionResponse ¶
type VerificationRequest ¶
type VerificationRequest struct {
ID string `json:"id"`
Identifier *string `json:"identifier,omitempty"`
Token *string `json:"token,omitempty"`
Email *string `json:"email,omitempty"`
Expires *int64 `json:"expires,omitempty"`
CreatedAt *int64 `json:"created_at,omitempty"`
UpdatedAt *int64 `json:"updated_at,omitempty"`
Nonce *string `json:"nonce,omitempty"`
RedirectURI *string `json:"redirect_uri,omitempty"`
}
type VerificationRequests ¶
type VerificationRequests struct {
Pagination *Pagination `json:"pagination"`
VerificationRequests []*VerificationRequest `json:"verification_requests"`
}
type VerifyEmailRequest ¶
type VerifyOTPRequest ¶
type VerifyOrgDomainRequest ¶
type WebauthnCredentialInfo ¶
type WebauthnLoginOptionsResponse ¶
type WebauthnLoginOptionsResponse struct {
Options string `json:"options"`
}
type WebauthnRegistrationOptionsResponse ¶
type WebauthnRegistrationOptionsResponse struct {
Options string `json:"options"`
}
type Webhook ¶
type Webhook struct {
ID string `json:"id"`
EventName *string `json:"event_name,omitempty"`
EventDescription *string `json:"event_description,omitempty"`
Endpoint *string `json:"endpoint,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
Headers map[string]any `json:"headers,omitempty"`
CreatedAt *int64 `json:"created_at,omitempty"`
UpdatedAt *int64 `json:"updated_at,omitempty"`
}
type WebhookLog ¶
type WebhookLog struct {
ID string `json:"id"`
HTTPStatus *int64 `json:"http_status,omitempty"`
Response *string `json:"response,omitempty"`
Request *string `json:"request,omitempty"`
WebhookID *string `json:"webhook_id,omitempty"`
CreatedAt *int64 `json:"created_at,omitempty"`
UpdatedAt *int64 `json:"updated_at,omitempty"`
}
type WebhookLogs ¶
type WebhookLogs struct {
Pagination *Pagination `json:"pagination"`
WebhookLogs []*WebhookLog `json:"webhook_logs"`
}
type WebhookRequest ¶
type WebhookRequest struct {
ID string `json:"id"`
}
type Webhooks ¶
type Webhooks struct {
Pagination *Pagination `json:"pagination"`
Webhooks []*Webhook `json:"webhooks"`
}
Click to show internal directories.
Click to hide internal directories.