okta

package
v2.20.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 14, 2023 License: Apache-2.0 Imports: 33 Imported by: 63

Documentation

Index

Constants

View Source 
const AccessTokenCacheKey = "OKTA_ACCESS_TOKEN"
View Source 
const Version = "2.17.0"

Variables

This section is empty.

Functions

func CheckResponseForError 

func CheckResponseForError(resp *http.Response) error

func CreateClientAssertion added in v2.17.0 

func CreateClientAssertion(orgURL, clientID string, privateKeySinger jose.Signer) (clientAssertion string, err error)

func CreateKeySigner added in v2.17.0 

func CreateKeySigner(privateKey, privateKeyID string) (jose.Signer, error)

func Get429BackoffTime 

func Get429BackoffTime(resp *http.Response) (int64, error)

func Int64Ptr added in v2.17.0 

func Int64Ptr(i int64) *int64

Types

type AccessPolicy added in v2.9.1 

type AccessPolicy struct {
	Embedded    interface{}           `json:"_embedded,omitempty"`
	Links       interface{}           `json:"_links,omitempty"`
	Conditions  *PolicyRuleConditions `json:"conditions,omitempty"`
	Created     *time.Time            `json:"created,omitempty"`
	Description string                `json:"description,omitempty"`
	Id          string                `json:"id,omitempty"`
	LastUpdated *time.Time            `json:"lastUpdated,omitempty"`
	Name        string                `json:"name,omitempty"`
	Priority    int64                 `json:"-"`
	PriorityPtr *int64                `json:"priority,omitempty"`
	Status      string                `json:"status,omitempty"`
	System      *bool                 `json:"system,omitempty"`
	Type        string                `json:"type,omitempty"`
}

func NewAccessPolicy added in v2.10.1 

func NewAccessPolicy() *AccessPolicy

func (*AccessPolicy) IsPolicyInstance added in v2.10.1 

func (a *AccessPolicy) IsPolicyInstance() bool

func (*AccessPolicy) MarshalJSON added in v2.17.0 

func (a *AccessPolicy) MarshalJSON() ([]byte, error)

func (*AccessPolicy) UnmarshalJSON added in v2.17.0 

func (a *AccessPolicy) UnmarshalJSON(data []byte) error

type AccessPolicyConstraint added in v2.9.1 

type AccessPolicyConstraint struct {
	Methods          []string `json:"methods,omitempty"`
	ReauthenticateIn string   `json:"reauthenticateIn,omitempty"`
	Types            []string `json:"types,omitempty"`
}

func NewAccessPolicyConstraint added in v2.10.1 

func NewAccessPolicyConstraint() *AccessPolicyConstraint

func (*AccessPolicyConstraint) IsPolicyInstance added in v2.10.1 

func (a *AccessPolicyConstraint) IsPolicyInstance() bool

type AccessPolicyConstraints added in v2.9.1 

type AccessPolicyConstraints struct {
	Knowledge  *KnowledgeConstraint  `json:"knowledge,omitempty"`
	Possession *PossessionConstraint `json:"possession,omitempty"`
}

func NewAccessPolicyConstraints added in v2.10.1 

func NewAccessPolicyConstraints() *AccessPolicyConstraints

func (*AccessPolicyConstraints) IsPolicyInstance added in v2.10.1 

func (a *AccessPolicyConstraints) IsPolicyInstance() bool

type AccessPolicyRule added in v2.9.1 

type AccessPolicyRule struct {
	Actions     *AccessPolicyRuleActions    `json:"actions,omitempty"`
	Conditions  *AccessPolicyRuleConditions `json:"conditions,omitempty"`
	Created     *time.Time                  `json:"created,omitempty"`
	Id          string                      `json:"id,omitempty"`
	LastUpdated *time.Time                  `json:"lastUpdated,omitempty"`
	Name        string                      `json:"name,omitempty"`
	Priority    int64                       `json:"-"`
	PriorityPtr *int64                      `json:"priority,omitempty"`
	Status      string                      `json:"status,omitempty"`
	System      *bool                       `json:"system,omitempty"`
	Type        string                      `json:"type,omitempty"`
}

func NewAccessPolicyRule added in v2.10.1 

func NewAccessPolicyRule() *AccessPolicyRule

func (*AccessPolicyRule) IsPolicyInstance added in v2.10.1 

func (a *AccessPolicyRule) IsPolicyInstance() bool

func (*AccessPolicyRule) MarshalJSON added in v2.17.0 

func (a *AccessPolicyRule) MarshalJSON() ([]byte, error)

func (*AccessPolicyRule) UnmarshalJSON added in v2.17.0 

func (a *AccessPolicyRule) UnmarshalJSON(data []byte) error

type AccessPolicyRuleActions added in v2.9.1 

type AccessPolicyRuleActions struct {
	Enroll                   *PolicyRuleActionsEnroll           `json:"enroll,omitempty"`
	Idp                      *IdpPolicyRuleAction               `json:"idp,omitempty"`
	PasswordChange           *PasswordPolicyRuleAction          `json:"passwordChange,omitempty"`
	SelfServicePasswordReset *PasswordPolicyRuleAction          `json:"selfServicePasswordReset,omitempty"`
	SelfServiceUnlock        *PasswordPolicyRuleAction          `json:"selfServiceUnlock,omitempty"`
	Signon                   *OktaSignOnPolicyRuleSignonActions `json:"signon,omitempty"`
	AppSignOn                *AccessPolicyRuleApplicationSignOn `json:"appSignOn,omitempty"`
}

func NewAccessPolicyRuleActions added in v2.10.1 

func NewAccessPolicyRuleActions() *AccessPolicyRuleActions

func (*AccessPolicyRuleActions) IsPolicyInstance added in v2.10.1 

func (a *AccessPolicyRuleActions) IsPolicyInstance() bool

type AccessPolicyRuleApplicationSignOn added in v2.9.1 

type AccessPolicyRuleApplicationSignOn struct {
	Access             string              `json:"access,omitempty"`
	VerificationMethod *VerificationMethod `json:"verificationMethod,omitempty"`
}

func NewAccessPolicyRuleApplicationSignOn added in v2.10.1 

func NewAccessPolicyRuleApplicationSignOn() *AccessPolicyRuleApplicationSignOn

func (*AccessPolicyRuleApplicationSignOn) IsPolicyInstance added in v2.10.1 

func (a *AccessPolicyRuleApplicationSignOn) IsPolicyInstance() bool

type AccessPolicyRuleConditions added in v2.9.1 

type AccessPolicyRuleConditions struct {
	App                   *AppAndInstancePolicyRuleCondition             `json:"app,omitempty"`
	Apps                  *AppInstancePolicyRuleCondition                `json:"apps,omitempty"`
	AuthContext           *PolicyRuleAuthContextCondition                `json:"authContext,omitempty"`
	AuthProvider          *PasswordPolicyAuthenticationProviderCondition `json:"authProvider,omitempty"`
	BeforeScheduledAction *BeforeScheduledActionPolicyRuleCondition      `json:"beforeScheduledAction,omitempty"`
	Clients               *ClientPolicyCondition                         `json:"clients,omitempty"`
	Context               *ContextPolicyRuleCondition                    `json:"context,omitempty"`
	Device                *DeviceAccessPolicyRuleCondition               `json:"device,omitempty"`
	GrantTypes            *GrantTypePolicyRuleCondition                  `json:"grantTypes,omitempty"`
	Groups                *GroupPolicyRuleCondition                      `json:"groups,omitempty"`
	IdentityProvider      *IdentityProviderPolicyRuleCondition           `json:"identityProvider,omitempty"`
	MdmEnrollment         *MDMEnrollmentPolicyRuleCondition              `json:"mdmEnrollment,omitempty"`
	Network               *PolicyNetworkCondition                        `json:"network,omitempty"`
	People                *PolicyPeopleCondition                         `json:"people,omitempty"`
	Platform              *PlatformPolicyRuleCondition                   `json:"platform,omitempty"`
	Risk                  *RiskPolicyRuleCondition                       `json:"risk,omitempty"`
	RiskScore             *RiskScorePolicyRuleCondition                  `json:"riskScore,omitempty"`
	Scopes                *OAuth2ScopesMediationPolicyRuleCondition      `json:"scopes,omitempty"`
	UserIdentifier        *UserIdentifierPolicyRuleCondition             `json:"userIdentifier,omitempty"`
	UserStatus            *UserStatusPolicyRuleCondition                 `json:"userStatus,omitempty"`
	Users                 *UserPolicyRuleCondition                       `json:"users,omitempty"`
	ElCondition           *AccessPolicyRuleCustomCondition               `json:"elCondition,omitempty"`
	UserType              *UserTypeCondition                             `json:"userType,omitempty"`
}

func NewAccessPolicyRuleConditions added in v2.10.1 

func NewAccessPolicyRuleConditions() *AccessPolicyRuleConditions

func (*AccessPolicyRuleConditions) IsPolicyInstance added in v2.10.1 

func (a *AccessPolicyRuleConditions) IsPolicyInstance() bool

type AccessPolicyRuleCustomCondition added in v2.9.1 

type AccessPolicyRuleCustomCondition struct {
	Condition string `json:"condition,omitempty"`
}

func NewAccessPolicyRuleCustomCondition added in v2.10.1 

func NewAccessPolicyRuleCustomCondition() *AccessPolicyRuleCustomCondition

func (*AccessPolicyRuleCustomCondition) IsPolicyInstance added in v2.10.1 

func (a *AccessPolicyRuleCustomCondition) IsPolicyInstance() bool

type AcsEndpoint added in v2.1.0 

type AcsEndpoint struct {
	Index    int64  `json:"-"`
	IndexPtr *int64 `json:"index,omitempty"`
	Url      string `json:"url,omitempty"`
}

func (*AcsEndpoint) MarshalJSON added in v2.17.0 

func (a *AcsEndpoint) MarshalJSON() ([]byte, error)

func (*AcsEndpoint) UnmarshalJSON added in v2.17.0 

func (a *AcsEndpoint) UnmarshalJSON(data []byte) error

type ActivateFactorRequest 

type ActivateFactorRequest struct {
	Attestation      string `json:"attestation,omitempty"`
	ClientData       string `json:"clientData,omitempty"`
	PassCode         string `json:"passCode,omitempty"`
	RegistrationData string `json:"registrationData,omitempty"`
	StateToken       string `json:"stateToken,omitempty"`
}

func NewActivateFactorRequest 

func NewActivateFactorRequest() *ActivateFactorRequest

func (*ActivateFactorRequest) IsUserFactorInstance 

func (a *ActivateFactorRequest) IsUserFactorInstance() bool

type AllowedForEnum added in v2.8.0 

type AllowedForEnum string

type App 

type App interface {
	IsApplicationInstance() bool
}

type AppAndInstanceConditionEvaluatorAppOrInstance 

type AppAndInstanceConditionEvaluatorAppOrInstance struct {
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
	Type string `json:"type,omitempty"`
}

func NewAppAndInstanceConditionEvaluatorAppOrInstance added in v2.10.1 

func NewAppAndInstanceConditionEvaluatorAppOrInstance() *AppAndInstanceConditionEvaluatorAppOrInstance

func (*AppAndInstanceConditionEvaluatorAppOrInstance) IsPolicyInstance added in v2.10.1 

func (a *AppAndInstanceConditionEvaluatorAppOrInstance) IsPolicyInstance() bool

type AppAndInstancePolicyRuleCondition 

type AppAndInstancePolicyRuleCondition struct {
	Exclude []*AppAndInstanceConditionEvaluatorAppOrInstance `json:"exclude,omitempty"`
	Include []*AppAndInstanceConditionEvaluatorAppOrInstance `json:"include,omitempty"`
}

func NewAppAndInstancePolicyRuleCondition added in v2.10.1 

func NewAppAndInstancePolicyRuleCondition() *AppAndInstancePolicyRuleCondition

func (*AppAndInstancePolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *AppAndInstancePolicyRuleCondition) IsPolicyInstance() bool

type AppInstancePolicyRuleCondition 

type AppInstancePolicyRuleCondition struct {
	Exclude []string `json:"exclude,omitempty"`
	Include []string `json:"include,omitempty"`
}

func NewAppInstancePolicyRuleCondition added in v2.10.1 

func NewAppInstancePolicyRuleCondition() *AppInstancePolicyRuleCondition

func (*AppInstancePolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *AppInstancePolicyRuleCondition) IsPolicyInstance() bool
type AppLink struct {
	AppAssignmentId  string `json:"appAssignmentId,omitempty"`
	AppInstanceId    string `json:"appInstanceId,omitempty"`
	AppName          string `json:"appName,omitempty"`
	CredentialsSetup *bool  `json:"credentialsSetup,omitempty"`
	Hidden           *bool  `json:"hidden,omitempty"`
	Id               string `json:"id,omitempty"`
	Label            string `json:"label,omitempty"`
	LinkUrl          string `json:"linkUrl,omitempty"`
	LogoUrl          string `json:"logoUrl,omitempty"`
	SortOrder        int64  `json:"-"`
	SortOrderPtr     *int64 `json:"sortOrder,omitempty"`
}

func (*AppLink) MarshalJSON added in v2.17.0 

func (a *AppLink) MarshalJSON() ([]byte, error)

func (*AppLink) UnmarshalJSON added in v2.17.0 

func (a *AppLink) UnmarshalJSON(data []byte) error

type AppUser 

type AppUser struct {
	Embedded        interface{}         `json:"_embedded,omitempty"`
	Links           interface{}         `json:"_links,omitempty"`
	Created         *time.Time          `json:"created,omitempty"`
	Credentials     *AppUserCredentials `json:"credentials,omitempty"`
	ExternalId      string              `json:"externalId,omitempty"`
	Id              string              `json:"id,omitempty"`
	LastSync        *time.Time          `json:"lastSync,omitempty"`
	LastUpdated     *time.Time          `json:"lastUpdated,omitempty"`
	PasswordChanged *time.Time          `json:"passwordChanged,omitempty"`
	Profile         interface{}         `json:"profile,omitempty"`
	Scope           string              `json:"scope,omitempty"`
	Status          string              `json:"status,omitempty"`
	StatusChanged   *time.Time          `json:"statusChanged,omitempty"`
	SyncState       string              `json:"syncState,omitempty"`
}

type AppUserCredentials 

type AppUserCredentials struct {
	Password *AppUserPasswordCredential `json:"password,omitempty"`
	UserName string                     `json:"userName"`
}

type AppUserPasswordCredential 

type AppUserPasswordCredential struct {
	Value string `json:"value,omitempty"`
}

type AppUserResource 

type AppUserResource resource

func (*AppUserResource) DeleteApplicationUser 

func (m *AppUserResource) DeleteApplicationUser(ctx context.Context, appId string, userId string, qp *query.Params) (*Response, error)

Removes an assignment for a user from an application.

func (*AppUserResource) UpdateApplicationUser 

func (m *AppUserResource) UpdateApplicationUser(ctx context.Context, appId string, userId string, body AppUser) (*AppUser, *Response, error)

Updates a user's profile for an application

type Application 

type Application struct {
	Embedded      interface{}               `json:"_embedded,omitempty"`
	Links         interface{}               `json:"_links,omitempty"`
	Accessibility *ApplicationAccessibility `json:"accessibility,omitempty"`
	Created       *time.Time                `json:"created,omitempty"`
	Credentials   *ApplicationCredentials   `json:"credentials,omitempty"`
	Features      []string                  `json:"features,omitempty"`
	Id            string                    `json:"id,omitempty"`
	Label         string                    `json:"label,omitempty"`
	LastUpdated   *time.Time                `json:"lastUpdated,omitempty"`
	Licensing     *ApplicationLicensing     `json:"licensing,omitempty"`
	Name          string                    `json:"name,omitempty"`
	Profile       interface{}               `json:"profile,omitempty"`
	Settings      *ApplicationSettings      `json:"settings,omitempty"`
	SignOnMode    string                    `json:"signOnMode,omitempty"`
	Status        string                    `json:"status,omitempty"`
	Visibility    *ApplicationVisibility    `json:"visibility,omitempty"`
}

func NewApplication 

func NewApplication() *Application

func (*Application) IsApplicationInstance 

func (a *Application) IsApplicationInstance() bool

type ApplicationAccessibility 

type ApplicationAccessibility struct {
	ErrorRedirectUrl string `json:"errorRedirectUrl,omitempty"`
	LoginRedirectUrl string `json:"loginRedirectUrl,omitempty"`
	SelfService      *bool  `json:"selfService,omitempty"`
}

type ApplicationCredentials 

type ApplicationCredentials struct {
	Signing          *ApplicationCredentialsSigning          `json:"signing,omitempty"`
	UserNameTemplate *ApplicationCredentialsUsernameTemplate `json:"userNameTemplate,omitempty"`
}

type ApplicationCredentialsOAuthClient 

type ApplicationCredentialsOAuthClient struct {
	AutoKeyRotation         *bool  `json:"autoKeyRotation,omitempty"`
	ClientId                string `json:"client_id,omitempty"`
	ClientSecret            string `json:"client_secret,omitempty"`
	PkceRequired            *bool  `json:"pkce_required,omitempty"`
	TokenEndpointAuthMethod string `json:"token_endpoint_auth_method,omitempty"`
}

type ApplicationCredentialsScheme 

type ApplicationCredentialsScheme string

type ApplicationCredentialsSigning 

type ApplicationCredentialsSigning struct {
	Kid          string     `json:"kid,omitempty"`
	LastRotated  *time.Time `json:"lastRotated,omitempty"`
	NextRotation *time.Time `json:"nextRotation,omitempty"`
	RotationMode string     `json:"rotationMode,omitempty"`
	Use          string     `json:"use,omitempty"`
}

type ApplicationCredentialsSigningUse 

type ApplicationCredentialsSigningUse string

type ApplicationCredentialsUsernameTemplate 

type ApplicationCredentialsUsernameTemplate struct {
	PushStatus string `json:"pushStatus,omitempty"`
	Suffix     string `json:"suffix,omitempty"`
	Template   string `json:"template,omitempty"`
	Type       string `json:"type,omitempty"`
}

type ApplicationFeature added in v2.10.0 

type ApplicationFeature struct {
	Links        interface{}         `json:"_links,omitempty"`
	Capabilities *CapabilitiesObject `json:"capabilities,omitempty"`
	Description  string              `json:"description,omitempty"`
	Name         string              `json:"name,omitempty"`
	Status       string              `json:"status,omitempty"`
}

func NewApplicationFeature added in v2.10.0 

func NewApplicationFeature() *ApplicationFeature

func (*ApplicationFeature) IsApplicationInstance added in v2.10.0 

func (a *ApplicationFeature) IsApplicationInstance() bool

type ApplicationFeatureResource added in v2.10.0 

type ApplicationFeatureResource resource

type ApplicationGroupAssignment 

type ApplicationGroupAssignment struct {
	Embedded    interface{} `json:"_embedded,omitempty"`
	Links       interface{} `json:"_links,omitempty"`
	Id          string      `json:"id,omitempty"`
	LastUpdated *time.Time  `json:"lastUpdated,omitempty"`
	Priority    int64       `json:"-"`
	PriorityPtr *int64      `json:"priority,omitempty"`
	Profile     interface{} `json:"profile,omitempty"`
}

func (*ApplicationGroupAssignment) MarshalJSON added in v2.17.0 

func (a *ApplicationGroupAssignment) MarshalJSON() ([]byte, error)

func (*ApplicationGroupAssignment) UnmarshalJSON added in v2.17.0 

func (a *ApplicationGroupAssignment) UnmarshalJSON(data []byte) error

type ApplicationGroupAssignmentResource 

type ApplicationGroupAssignmentResource resource

func (*ApplicationGroupAssignmentResource) DeleteApplicationGroupAssignment 

func (m *ApplicationGroupAssignmentResource) DeleteApplicationGroupAssignment(ctx context.Context, appId string, groupId string) (*Response, error)

Removes a group assignment from an application.

type ApplicationLicensing 

type ApplicationLicensing struct {
	SeatCount    int64  `json:"-"`
	SeatCountPtr *int64 `json:"seatCount,omitempty"`
}

func (*ApplicationLicensing) MarshalJSON added in v2.17.0 

func (a *ApplicationLicensing) MarshalJSON() ([]byte, error)

func (*ApplicationLicensing) UnmarshalJSON added in v2.17.0 

func (a *ApplicationLicensing) UnmarshalJSON(data []byte) error

type ApplicationResource 

type ApplicationResource resource

func (*ApplicationResource) ActivateApplication 

func (m *ApplicationResource) ActivateApplication(ctx context.Context, appId string) (*Response, error)

Activates an inactive application.

func (*ApplicationResource) ActivateClientSecretForApplication added in v2.15.0 

func (m *ApplicationResource) ActivateClientSecretForApplication(ctx context.Context, appId string, secretId string) (*ClientSecret, *Response, error)

Activates a specific client secret by secretId

func (*ApplicationResource) ActivateDefaultProvisioningConnectionForApplication added in v2.10.0 

func (m *ApplicationResource) ActivateDefaultProvisioningConnectionForApplication(ctx context.Context, appId string) (*Response, error)

Activates the default Provisioning Connection for an application.

func (*ApplicationResource) AssignUserToApplication 

func (m *ApplicationResource) AssignUserToApplication(ctx context.Context, appId string, body AppUser) (*AppUser, *Response, error)

Assigns an user to an application with [credentials](#application-user-credentials-object) and an app-specific [profile](#application-user-profile-object). Profile mappings defined for the application are first applied before applying any profile properties specified in the request.

func (*ApplicationResource) CloneApplicationKey 

func (m *ApplicationResource) CloneApplicationKey(ctx context.Context, appId string, keyId string, qp *query.Params) (*JsonWebKey, *Response, error)

Clones a X.509 certificate for an application key credential from a source application to target application.

func (*ApplicationResource) CreateApplication 

func (m *ApplicationResource) CreateApplication(ctx context.Context, body App, qp *query.Params) (App, *Response, error)

Adds a new application to your Okta organization.

func (*ApplicationResource) CreateApplicationGroupAssignment 

func (m *ApplicationResource) CreateApplicationGroupAssignment(ctx context.Context, appId string, groupId string, body ApplicationGroupAssignment) (*ApplicationGroupAssignment, *Response, error)

Assigns a group to an application

func (*ApplicationResource) CreateNewClientSecretForApplication added in v2.15.0 

func (m *ApplicationResource) CreateNewClientSecretForApplication(ctx context.Context, appId string, body ClientSecretMetadata) (*ClientSecret, *Response, error)

Adds a new secret to the client's collection of secrets.

func (*ApplicationResource) DeactivateApplication 

func (m *ApplicationResource) DeactivateApplication(ctx context.Context, appId string) (*Response, error)

Deactivates an active application.

func (*ApplicationResource) DeactivateClientSecretForApplication added in v2.15.0 

func (m *ApplicationResource) DeactivateClientSecretForApplication(ctx context.Context, appId string, secretId string) (*ClientSecret, *Response, error)

Deactivates a specific client secret by secretId

func (*ApplicationResource) DeactivateDefaultProvisioningConnectionForApplication added in v2.10.0 

func (m *ApplicationResource) DeactivateDefaultProvisioningConnectionForApplication(ctx context.Context, appId string) (*Response, error)

Deactivates the default Provisioning Connection for an application.

func (*ApplicationResource) DeleteApplication 

func (m *ApplicationResource) DeleteApplication(ctx context.Context, appId string) (*Response, error)

Removes an inactive application.

func (*ApplicationResource) DeleteApplicationGroupAssignment 

func (m *ApplicationResource) DeleteApplicationGroupAssignment(ctx context.Context, appId string, groupId string) (*Response, error)

Removes a group assignment from an application.

func (*ApplicationResource) DeleteApplicationUser 

func (m *ApplicationResource) DeleteApplicationUser(ctx context.Context, appId string, userId string, qp *query.Params) (*Response, error)

Removes an assignment for a user from an application.

func (*ApplicationResource) DeleteClientSecretForApplication added in v2.15.0 

func (m *ApplicationResource) DeleteClientSecretForApplication(ctx context.Context, appId string, secretId string) (*Response, error)

Removes a secret from the client's collection of secrets.

func (*ApplicationResource) GenerateApplicationKey 

func (m *ApplicationResource) GenerateApplicationKey(ctx context.Context, appId string, qp *query.Params) (*JsonWebKey, *Response, error)

Generates a new X.509 certificate for an application key credential

func (*ApplicationResource) GenerateCsrForApplication 

func (m *ApplicationResource) GenerateCsrForApplication(ctx context.Context, appId string, body CsrMetadata) (*Csr, *Response, error)

Generates a new key pair and returns the Certificate Signing Request for it.

func (*ApplicationResource) GetApplication 

func (m *ApplicationResource) GetApplication(ctx context.Context, appId string, appInstance App, qp *query.Params) (App, *Response, error)

Fetches an application from your Okta organization by `id`.

func (*ApplicationResource) GetApplicationGroupAssignment 

func (m *ApplicationResource) GetApplicationGroupAssignment(ctx context.Context, appId string, groupId string, qp *query.Params) (*ApplicationGroupAssignment, *Response, error)

Fetches an application group assignment

func (*ApplicationResource) GetApplicationKey 

func (m *ApplicationResource) GetApplicationKey(ctx context.Context, appId string, keyId string) (*JsonWebKey, *Response, error)

Gets a specific application key credential by kid

func (*ApplicationResource) GetApplicationUser 

func (m *ApplicationResource) GetApplicationUser(ctx context.Context, appId string, userId string, qp *query.Params) (*AppUser, *Response, error)

Fetches a specific user assignment for application by `id`.

func (*ApplicationResource) GetClientSecretForApplication added in v2.15.0 

func (m *ApplicationResource) GetClientSecretForApplication(ctx context.Context, appId string, secretId string) (*ClientSecret, *Response, error)

Gets a specific client secret by secretId

func (*ApplicationResource) GetCsrForApplication 

func (m *ApplicationResource) GetCsrForApplication(ctx context.Context, appId string, csrId string) (*Csr, *Response, error)

func (*ApplicationResource) GetDefaultProvisioningConnectionForApplication added in v2.10.0 

func (m *ApplicationResource) GetDefaultProvisioningConnectionForApplication(ctx context.Context, appId string) (*ProvisioningConnection, *Response, error)

Get default Provisioning Connection for application

func (*ApplicationResource) GetFeatureForApplication added in v2.10.0 

func (m *ApplicationResource) GetFeatureForApplication(ctx context.Context, appId string, name string) (*ApplicationFeature, *Response, error)

Fetches a Feature object for an application.

func (*ApplicationResource) GetOAuth2TokenForApplication 

func (m *ApplicationResource) GetOAuth2TokenForApplication(ctx context.Context, appId string, tokenId string, qp *query.Params) (*OAuth2Token, *Response, error)

Gets a token for the specified application

func (*ApplicationResource) GetScopeConsentGrant 

func (m *ApplicationResource) GetScopeConsentGrant(ctx context.Context, appId string, grantId string, qp *query.Params) (*OAuth2ScopeConsentGrant, *Response, error)

Fetches a single scope consent grant for the application

func (*ApplicationResource) GrantConsentToScope 

func (m *ApplicationResource) GrantConsentToScope(ctx context.Context, appId string, body OAuth2ScopeConsentGrant) (*OAuth2ScopeConsentGrant, *Response, error)

Grants consent for the application to request an OAuth 2.0 Okta scope

func (*ApplicationResource) ListApplicationGroupAssignments 

func (m *ApplicationResource) ListApplicationGroupAssignments(ctx context.Context, appId string, qp *query.Params) ([]*ApplicationGroupAssignment, *Response, error)

Enumerates group assignments for an application.

func (*ApplicationResource) ListApplicationKeys 

func (m *ApplicationResource) ListApplicationKeys(ctx context.Context, appId string) ([]*JsonWebKey, *Response, error)

Enumerates key credentials for an application

func (*ApplicationResource) ListApplicationUsers 

func (m *ApplicationResource) ListApplicationUsers(ctx context.Context, appId string, qp *query.Params) ([]*AppUser, *Response, error)

Enumerates all assigned [application users](#application-user-model) for an application.

func (*ApplicationResource) ListApplications 

func (m *ApplicationResource) ListApplications(ctx context.Context, qp *query.Params) ([]App, *Response, error)

Enumerates apps added to your organization with pagination. A subset of apps can be returned that match a supported filter expression or query.

func (*ApplicationResource) ListClientSecretsForApplication added in v2.15.0 

func (m *ApplicationResource) ListClientSecretsForApplication(ctx context.Context, appId string) ([]*ClientSecret, *Response, error)

Enumerates the client's collection of secrets

func (*ApplicationResource) ListCsrsForApplication 

func (m *ApplicationResource) ListCsrsForApplication(ctx context.Context, appId string) ([]*Csr, *Response, error)

Enumerates Certificate Signing Requests for an application

func (*ApplicationResource) ListFeaturesForApplication added in v2.10.0 

func (m *ApplicationResource) ListFeaturesForApplication(ctx context.Context, appId string) ([]*ApplicationFeature, *Response, error)

List Features for application

func (*ApplicationResource) ListOAuth2TokensForApplication 

func (m *ApplicationResource) ListOAuth2TokensForApplication(ctx context.Context, appId string, qp *query.Params) ([]*OAuth2Token, *Response, error)

Lists all tokens for the application

func (*ApplicationResource) ListScopeConsentGrants 

func (m *ApplicationResource) ListScopeConsentGrants(ctx context.Context, appId string, qp *query.Params) ([]*OAuth2ScopeConsentGrant, *Response, error)

Lists all scope consent grants for the application

func (*ApplicationResource) PreviewSAMLAppMetadata added in v2.17.0 

func (m *ApplicationResource) PreviewSAMLAppMetadata(ctx context.Context, appId string, qp *query.Params) (*Response, error)

Previews SAML metadata based on a specific key credential for an application

func (*ApplicationResource) PublishBinaryCerCert 

func (m *ApplicationResource) PublishBinaryCerCert(ctx context.Context, appId string, csrId string, body string) (*JsonWebKey, *Response, error)

func (*ApplicationResource) PublishBinaryDerCert 

func (m *ApplicationResource) PublishBinaryDerCert(ctx context.Context, appId string, csrId string, body string) (*JsonWebKey, *Response, error)

func (*ApplicationResource) PublishBinaryPemCert 

func (m *ApplicationResource) PublishBinaryPemCert(ctx context.Context, appId string, csrId string, body string) (*JsonWebKey, *Response, error)

func (*ApplicationResource) PublishCerCert 

func (m *ApplicationResource) PublishCerCert(ctx context.Context, appId string, csrId string, body string) (*JsonWebKey, *Response, error)

func (*ApplicationResource) PublishDerCert 

func (m *ApplicationResource) PublishDerCert(ctx context.Context, appId string, csrId string, body string) (*JsonWebKey, *Response, error)

func (*ApplicationResource) RevokeCsrFromApplication 

func (m *ApplicationResource) RevokeCsrFromApplication(ctx context.Context, appId string, csrId string) (*Response, error)

func (*ApplicationResource) RevokeOAuth2TokenForApplication 

func (m *ApplicationResource) RevokeOAuth2TokenForApplication(ctx context.Context, appId string, tokenId string) (*Response, error)

Revokes the specified token for the specified application

func (*ApplicationResource) RevokeOAuth2TokensForApplication 

func (m *ApplicationResource) RevokeOAuth2TokensForApplication(ctx context.Context, appId string) (*Response, error)

Revokes all tokens for the specified application

func (*ApplicationResource) RevokeScopeConsentGrant 

func (m *ApplicationResource) RevokeScopeConsentGrant(ctx context.Context, appId string, grantId string) (*Response, error)

Revokes permission for the application to request the given scope

func (*ApplicationResource) SetDefaultProvisioningConnectionForApplication added in v2.10.0 

func (m *ApplicationResource) SetDefaultProvisioningConnectionForApplication(ctx context.Context, appId string, body ProvisioningConnectionRequest, qp *query.Params) (*ProvisioningConnection, *Response, error)

Set default Provisioning Connection for application

func (*ApplicationResource) UpdateApplication 

func (m *ApplicationResource) UpdateApplication(ctx context.Context, appId string, body App) (App, *Response, error)

Updates an application in your organization.

func (*ApplicationResource) UpdateApplicationPolicy added in v2.12.0 

func (m *ApplicationResource) UpdateApplicationPolicy(ctx context.Context, appId string, policyId string) (*Response, error)

Assign an application to a specific policy. This unassigns the application from its currently assigned policy.

func (*ApplicationResource) UpdateApplicationUser 

func (m *ApplicationResource) UpdateApplicationUser(ctx context.Context, appId string, userId string, body AppUser) (*AppUser, *Response, error)

Updates a user's profile for an application

func (*ApplicationResource) UpdateFeatureForApplication added in v2.10.0 

func (m *ApplicationResource) UpdateFeatureForApplication(ctx context.Context, appId string, name string, body CapabilitiesObject) (*ApplicationFeature, *Response, error)

Updates a Feature object for an application. 

func (m *ApplicationResource) UploadApplicationLogo(ctx context.Context, appId string, file string) (*Response, error)

Update the logo for an application.

type ApplicationSettings 

type ApplicationSettings struct {
	App                *ApplicationSettingsApplication   `json:"app,omitempty"`
	ImplicitAssignment *bool                             `json:"implicitAssignment,omitempty"`
	InlineHookId       string                            `json:"inlineHookId,omitempty"`
	Notes              *ApplicationSettingsNotes         `json:"notes,omitempty"`
	Notifications      *ApplicationSettingsNotifications `json:"notifications,omitempty"`
}

type ApplicationSettingsApplication 

type ApplicationSettingsApplication map[string]interface{}

type ApplicationSettingsNotes added in v2.6.0 

type ApplicationSettingsNotes struct {
	Admin   *string `json:"admin"`
	Enduser *string `json:"enduser"`
}

type ApplicationSettingsNotifications 

type ApplicationSettingsNotifications struct {
	Vpn *ApplicationSettingsNotificationsVpn `json:"vpn,omitempty"`
}

type ApplicationSettingsNotificationsVpn 

type ApplicationSettingsNotificationsVpn struct {
	HelpUrl string                                      `json:"helpUrl,omitempty"`
	Message string                                      `json:"message,omitempty"`
	Network *ApplicationSettingsNotificationsVpnNetwork `json:"network,omitempty"`
}

type ApplicationSettingsNotificationsVpnNetwork 

type ApplicationSettingsNotificationsVpnNetwork struct {
	Connection string   `json:"connection,omitempty"`
	Exclude    []string `json:"exclude,omitempty"`
	Include    []string `json:"include,omitempty"`
}

type ApplicationSignOnMode 

type ApplicationSignOnMode string

type ApplicationVisibility 

type ApplicationVisibility struct {
	AppLinks          map[string]bool            `json:"appLinks,omitempty"`
	AutoLaunch        *bool                      `json:"autoLaunch,omitempty"`
	AutoSubmitToolbar *bool                      `json:"autoSubmitToolbar,omitempty"`
	Hide              *ApplicationVisibilityHide `json:"hide,omitempty"`
}

type ApplicationVisibilityHide 

type ApplicationVisibilityHide struct {
	IOS *bool `json:"iOS,omitempty"`
	Web *bool `json:"web,omitempty"`
}

type AssignRoleRequest 

type AssignRoleRequest struct {
	Type string `json:"type,omitempty"`
}

type AuthenticationProvider 

type AuthenticationProvider struct {
	Name string `json:"name,omitempty"`
	Type string `json:"type,omitempty"`
}

type AuthenticationProviderType 

type AuthenticationProviderType string

type Authenticator added in v2.8.0 

type Authenticator struct {
	Links       interface{}            `json:"_links,omitempty"`
	Created     *time.Time             `json:"created,omitempty"`
	Id          string                 `json:"id,omitempty"`
	Key         string                 `json:"key,omitempty"`
	LastUpdated *time.Time             `json:"lastUpdated,omitempty"`
	Name        string                 `json:"name,omitempty"`
	Provider    *AuthenticatorProvider `json:"provider,omitempty"`
	Settings    *AuthenticatorSettings `json:"settings,omitempty"`
	Status      string                 `json:"status,omitempty"`
	Type        string                 `json:"type,omitempty"`
}

type AuthenticatorProvider added in v2.9.1 

type AuthenticatorProvider struct {
	Configuration *AuthenticatorProviderConfiguration `json:"configuration,omitempty"`
	Type          string                              `json:"type,omitempty"`
}

type AuthenticatorProviderConfiguration added in v2.9.1 

type AuthenticatorProviderConfiguration struct {
	AuthPort         int64                                            `json:"-"`
	AuthPortPtr      *int64                                           `json:"authPort,omitempty"`
	Host             string                                           `json:"host,omitempty"`
	HostName         string                                           `json:"hostName,omitempty"`
	InstanceId       string                                           `json:"instanceId,omitempty"`
	IntegrationKey   string                                           `json:"integrationKey,omitempty"`
	SecretKey        string                                           `json:"secretKey,omitempty"`
	SharedSecret     string                                           `json:"sharedSecret,omitempty"`
	UserNameTemplate *AuthenticatorProviderConfigurationUserNamePlate `json:"userNameTemplate,omitempty"`
}

func (*AuthenticatorProviderConfiguration) MarshalJSON added in v2.17.0 

func (a *AuthenticatorProviderConfiguration) MarshalJSON() ([]byte, error)

func (*AuthenticatorProviderConfiguration) UnmarshalJSON added in v2.17.0 

func (a *AuthenticatorProviderConfiguration) UnmarshalJSON(data []byte) error

type AuthenticatorProviderConfigurationUserNamePlate added in v2.9.1 

type AuthenticatorProviderConfigurationUserNamePlate struct {
	Template string `json:"template,omitempty"`
}

type AuthenticatorResource added in v2.8.0 

type AuthenticatorResource resource

func (*AuthenticatorResource) ActivateAuthenticator added in v2.8.0 

func (m *AuthenticatorResource) ActivateAuthenticator(ctx context.Context, authenticatorId string) (*Authenticator, *Response, error)

func (*AuthenticatorResource) CreateAuthenticator added in v2.15.0 

func (m *AuthenticatorResource) CreateAuthenticator(ctx context.Context, body Authenticator, qp *query.Params) (*Authenticator, *Response, error)

Create Authenticator

func (*AuthenticatorResource) DeactivateAuthenticator added in v2.8.0 

func (m *AuthenticatorResource) DeactivateAuthenticator(ctx context.Context, authenticatorId string) (*Authenticator, *Response, error)

func (*AuthenticatorResource) GetAuthenticator added in v2.8.0 

func (m *AuthenticatorResource) GetAuthenticator(ctx context.Context, authenticatorId string) (*Authenticator, *Response, error)

func (*AuthenticatorResource) ListAuthenticators added in v2.8.0 

func (m *AuthenticatorResource) ListAuthenticators(ctx context.Context) ([]*Authenticator, *Response, error)

List Authenticators

func (*AuthenticatorResource) UpdateAuthenticator added in v2.9.1 

func (m *AuthenticatorResource) UpdateAuthenticator(ctx context.Context, authenticatorId string, body Authenticator) (*Authenticator, *Response, error)

Updates an authenticator

type AuthenticatorSettings added in v2.8.0 

type AuthenticatorSettings struct {
	AllowedFor                string          `json:"allowedFor,omitempty"`
	AppInstanceId             string          `json:"appInstanceId,omitempty"`
	ChannelBinding            *ChannelBinding `json:"channelBinding,omitempty"`
	Compliance                *Compliance     `json:"compliance,omitempty"`
	TokenLifetimeInMinutes    int64           `json:"-"`
	TokenLifetimeInMinutesPtr *int64          `json:"tokenLifetimeInMinutes,omitempty"`
	UserVerification          string          `json:"userVerification,omitempty"`
}

func (*AuthenticatorSettings) MarshalJSON added in v2.17.0 

func (a *AuthenticatorSettings) MarshalJSON() ([]byte, error)

func (*AuthenticatorSettings) UnmarshalJSON added in v2.17.0 

func (a *AuthenticatorSettings) UnmarshalJSON(data []byte) error

type AuthenticatorStatus added in v2.8.0 

type AuthenticatorStatus string

type AuthenticatorType added in v2.8.0 

type AuthenticatorType string

type Authorization added in v2.17.0 

type Authorization interface {
	Authorize() error
}

type AuthorizationServer 

type AuthorizationServer struct {
	Links       interface{}                     `json:"_links,omitempty"`
	Audiences   []string                        `json:"audiences,omitempty"`
	Created     *time.Time                      `json:"created,omitempty"`
	Credentials *AuthorizationServerCredentials `json:"credentials,omitempty"`
	Default     *bool                           `json:"default,omitempty"`
	Description string                          `json:"description,omitempty"`
	Id          string                          `json:"id,omitempty"`
	Issuer      string                          `json:"issuer,omitempty"`
	IssuerMode  string                          `json:"issuerMode,omitempty"`
	LastUpdated *time.Time                      `json:"lastUpdated,omitempty"`
	Name        string                          `json:"name,omitempty"`
	Status      string                          `json:"status,omitempty"`
}

type AuthorizationServerCredentials 

type AuthorizationServerCredentials struct {
	Signing *AuthorizationServerCredentialsSigningConfig `json:"signing,omitempty"`
}

type AuthorizationServerCredentialsRotationMode 

type AuthorizationServerCredentialsRotationMode string

type AuthorizationServerCredentialsSigningConfig 

type AuthorizationServerCredentialsSigningConfig struct {
	Kid          string     `json:"kid,omitempty"`
	LastRotated  *time.Time `json:"lastRotated,omitempty"`
	NextRotation *time.Time `json:"nextRotation,omitempty"`
	RotationMode string     `json:"rotationMode,omitempty"`
	Use          string     `json:"use,omitempty"`
}

type AuthorizationServerCredentialsUse 

type AuthorizationServerCredentialsUse string

type AuthorizationServerPolicy added in v2.3.0 

type AuthorizationServerPolicy struct {
	Embedded    interface{}           `json:"_embedded,omitempty"`
	Links       interface{}           `json:"_links,omitempty"`
	Conditions  *PolicyRuleConditions `json:"conditions,omitempty"`
	Created     *time.Time            `json:"created,omitempty"`
	Description string                `json:"description,omitempty"`
	Id          string                `json:"id,omitempty"`
	LastUpdated *time.Time            `json:"lastUpdated,omitempty"`
	Name        string                `json:"name,omitempty"`
	Priority    int64                 `json:"-"`
	PriorityPtr *int64                `json:"priority,omitempty"`
	Status      string                `json:"status,omitempty"`
	System      *bool                 `json:"system,omitempty"`
	Type        string                `json:"type,omitempty"`
}

func (*AuthorizationServerPolicy) MarshalJSON added in v2.17.0 

func (a *AuthorizationServerPolicy) MarshalJSON() ([]byte, error)

func (*AuthorizationServerPolicy) UnmarshalJSON added in v2.17.0 

func (a *AuthorizationServerPolicy) UnmarshalJSON(data []byte) error

type AuthorizationServerPolicyResource added in v2.3.0 

type AuthorizationServerPolicyResource resource

func (*AuthorizationServerPolicyResource) DeleteAuthorizationServerPolicy added in v2.3.0 

func (m *AuthorizationServerPolicyResource) DeleteAuthorizationServerPolicy(ctx context.Context, authServerId string, policyId string) (*Response, error)

func (*AuthorizationServerPolicyResource) GetAuthorizationServerPolicy added in v2.3.0 

func (m *AuthorizationServerPolicyResource) GetAuthorizationServerPolicy(ctx context.Context, authServerId string, policyId string) (*AuthorizationServerPolicy, *Response, error)

func (*AuthorizationServerPolicyResource) UpdateAuthorizationServerPolicy added in v2.3.0 

func (m *AuthorizationServerPolicyResource) UpdateAuthorizationServerPolicy(ctx context.Context, authServerId string, policyId string, body AuthorizationServerPolicy) (*AuthorizationServerPolicy, *Response, error)

type AuthorizationServerPolicyRule added in v2.3.0 

type AuthorizationServerPolicyRule struct {
	Actions     *AuthorizationServerPolicyRuleActions    `json:"actions,omitempty"`
	Conditions  *AuthorizationServerPolicyRuleConditions `json:"conditions,omitempty"`
	Created     *time.Time                               `json:"created,omitempty"`
	Id          string                                   `json:"id,omitempty"`
	LastUpdated *time.Time                               `json:"lastUpdated,omitempty"`
	Name        string                                   `json:"name,omitempty"`
	Priority    int64                                    `json:"-"`
	PriorityPtr *int64                                   `json:"priority,omitempty"`
	Status      string                                   `json:"status,omitempty"`
	System      *bool                                    `json:"system,omitempty"`
	Type        string                                   `json:"type,omitempty"`
}

func (*AuthorizationServerPolicyRule) MarshalJSON added in v2.17.0 

func (a *AuthorizationServerPolicyRule) MarshalJSON() ([]byte, error)

func (*AuthorizationServerPolicyRule) UnmarshalJSON added in v2.17.0 

func (a *AuthorizationServerPolicyRule) UnmarshalJSON(data []byte) error

type AuthorizationServerPolicyRuleActions added in v2.3.0 

type AuthorizationServerPolicyRuleActions struct {
	Token *TokenAuthorizationServerPolicyRuleAction `json:"token,omitempty"`
}

type AuthorizationServerPolicyRuleConditions added in v2.3.0 

type AuthorizationServerPolicyRuleConditions struct {
	Clients    *ClientPolicyCondition                    `json:"clients,omitempty"`
	GrantTypes *GrantTypePolicyRuleCondition             `json:"grantTypes,omitempty"`
	People     *PolicyPeopleCondition                    `json:"people,omitempty"`
	Scopes     *OAuth2ScopesMediationPolicyRuleCondition `json:"scopes,omitempty"`
}

type AuthorizationServerPolicyRuleResource added in v2.3.0 

type AuthorizationServerPolicyRuleResource resource

func (*AuthorizationServerPolicyRuleResource) DeleteAuthorizationServerPolicyRule added in v2.3.0 

func (m *AuthorizationServerPolicyRuleResource) DeleteAuthorizationServerPolicyRule(ctx context.Context, authServerId string, policyId string, ruleId string) (*Response, error)

Deletes a Policy Rule defined in the specified Custom Authorization Server and Policy.

func (*AuthorizationServerPolicyRuleResource) UpdateAuthorizationServerPolicyRule added in v2.3.0 

func (m *AuthorizationServerPolicyRuleResource) UpdateAuthorizationServerPolicyRule(ctx context.Context, authServerId string, policyId string, ruleId string, body AuthorizationServerPolicyRule) (*AuthorizationServerPolicyRule, *Response, error)

Updates the configuration of the Policy Rule defined in the specified Custom Authorization Server and Policy.

type AuthorizationServerResource 

type AuthorizationServerResource resource

func (*AuthorizationServerResource) ActivateAuthorizationServer 

func (m *AuthorizationServerResource) ActivateAuthorizationServer(ctx context.Context, authServerId string) (*Response, error)

func (*AuthorizationServerResource) ActivateAuthorizationServerPolicy added in v2.5.2 

func (m *AuthorizationServerResource) ActivateAuthorizationServerPolicy(ctx context.Context, authServerId string, policyId string) (*Response, error)

Activate Authorization Server Policy

func (*AuthorizationServerResource) ActivateAuthorizationServerPolicyRule added in v2.5.2 

func (m *AuthorizationServerResource) ActivateAuthorizationServerPolicyRule(ctx context.Context, authServerId string, policyId string, ruleId string) (*Response, error)

Activate Authorization Server Policy Rule

func (*AuthorizationServerResource) CreateAuthorizationServer 

func (m *AuthorizationServerResource) CreateAuthorizationServer(ctx context.Context, body AuthorizationServer) (*AuthorizationServer, *Response, error)

func (*AuthorizationServerResource) CreateAuthorizationServerPolicy 

func (m *AuthorizationServerResource) CreateAuthorizationServerPolicy(ctx context.Context, authServerId string, body AuthorizationServerPolicy) (*AuthorizationServerPolicy, *Response, error)

func (*AuthorizationServerResource) CreateAuthorizationServerPolicyRule added in v2.5.2 

func (m *AuthorizationServerResource) CreateAuthorizationServerPolicyRule(ctx context.Context, authServerId string, policyId string, body AuthorizationServerPolicyRule) (*AuthorizationServerPolicyRule, *Response, error)

Creates a policy rule for the specified Custom Authorization Server and Policy.

func (*AuthorizationServerResource) CreateOAuth2Claim 

func (m *AuthorizationServerResource) CreateOAuth2Claim(ctx context.Context, authServerId string, body OAuth2Claim) (*OAuth2Claim, *Response, error)

func (*AuthorizationServerResource) CreateOAuth2Scope 

func (m *AuthorizationServerResource) CreateOAuth2Scope(ctx context.Context, authServerId string, body OAuth2Scope) (*OAuth2Scope, *Response, error)

func (*AuthorizationServerResource) DeactivateAuthorizationServer 

func (m *AuthorizationServerResource) DeactivateAuthorizationServer(ctx context.Context, authServerId string) (*Response, error)

func (*AuthorizationServerResource) DeactivateAuthorizationServerPolicy added in v2.5.2 

func (m *AuthorizationServerResource) DeactivateAuthorizationServerPolicy(ctx context.Context, authServerId string, policyId string) (*Response, error)

Deactivate Authorization Server Policy

func (*AuthorizationServerResource) DeactivateAuthorizationServerPolicyRule added in v2.5.2 

func (m *AuthorizationServerResource) DeactivateAuthorizationServerPolicyRule(ctx context.Context, authServerId string, policyId string, ruleId string) (*Response, error)

Deactivate Authorization Server Policy Rule

func (*AuthorizationServerResource) DeleteAuthorizationServer 

func (m *AuthorizationServerResource) DeleteAuthorizationServer(ctx context.Context, authServerId string) (*Response, error)

func (*AuthorizationServerResource) DeleteAuthorizationServerPolicy 

func (m *AuthorizationServerResource) DeleteAuthorizationServerPolicy(ctx context.Context, authServerId string, policyId string) (*Response, error)

func (*AuthorizationServerResource) DeleteAuthorizationServerPolicyRule added in v2.5.2 

func (m *AuthorizationServerResource) DeleteAuthorizationServerPolicyRule(ctx context.Context, authServerId string, policyId string, ruleId string) (*Response, error)

Deletes a Policy Rule defined in the specified Custom Authorization Server and Policy.

func (*AuthorizationServerResource) DeleteOAuth2Claim 

func (m *AuthorizationServerResource) DeleteOAuth2Claim(ctx context.Context, authServerId string, claimId string) (*Response, error)

func (*AuthorizationServerResource) DeleteOAuth2Scope 

func (m *AuthorizationServerResource) DeleteOAuth2Scope(ctx context.Context, authServerId string, scopeId string) (*Response, error)

func (*AuthorizationServerResource) GetAuthorizationServer 

func (m *AuthorizationServerResource) GetAuthorizationServer(ctx context.Context, authServerId string) (*AuthorizationServer, *Response, error)

func (*AuthorizationServerResource) GetAuthorizationServerPolicy 

func (m *AuthorizationServerResource) GetAuthorizationServerPolicy(ctx context.Context, authServerId string, policyId string) (*AuthorizationServerPolicy, *Response, error)

func (*AuthorizationServerResource) GetAuthorizationServerPolicyRule added in v2.5.2 

func (m *AuthorizationServerResource) GetAuthorizationServerPolicyRule(ctx context.Context, authServerId string, policyId string, ruleId string) (*AuthorizationServerPolicyRule, *Response, error)

Returns a Policy Rule by ID that is defined in the specified Custom Authorization Server and Policy.

func (*AuthorizationServerResource) GetOAuth2Claim 

func (m *AuthorizationServerResource) GetOAuth2Claim(ctx context.Context, authServerId string, claimId string) (*OAuth2Claim, *Response, error)

func (*AuthorizationServerResource) GetOAuth2Scope 

func (m *AuthorizationServerResource) GetOAuth2Scope(ctx context.Context, authServerId string, scopeId string) (*OAuth2Scope, *Response, error)

func (*AuthorizationServerResource) GetRefreshTokenForAuthorizationServerAndClient 

func (m *AuthorizationServerResource) GetRefreshTokenForAuthorizationServerAndClient(ctx context.Context, authServerId string, clientId string, tokenId string, qp *query.Params) (*OAuth2RefreshToken, *Response, error)

func (*AuthorizationServerResource) ListAuthorizationServerKeys 

func (m *AuthorizationServerResource) ListAuthorizationServerKeys(ctx context.Context, authServerId string) ([]*JsonWebKey, *Response, error)

func (*AuthorizationServerResource) ListAuthorizationServerPolicies 

func (m *AuthorizationServerResource) ListAuthorizationServerPolicies(ctx context.Context, authServerId string) ([]*AuthorizationServerPolicy, *Response, error)

func (*AuthorizationServerResource) ListAuthorizationServerPolicyRules added in v2.5.2 

func (m *AuthorizationServerResource) ListAuthorizationServerPolicyRules(ctx context.Context, authServerId string, policyId string) ([]*AuthorizationServerPolicyRule, *Response, error)

Enumerates all policy rules for the specified Custom Authorization Server and Policy.

func (*AuthorizationServerResource) ListAuthorizationServers 

func (m *AuthorizationServerResource) ListAuthorizationServers(ctx context.Context, qp *query.Params) ([]*AuthorizationServer, *Response, error)

func (*AuthorizationServerResource) ListOAuth2Claims 

func (m *AuthorizationServerResource) ListOAuth2Claims(ctx context.Context, authServerId string) ([]*OAuth2Claim, *Response, error)

func (*AuthorizationServerResource) ListOAuth2ClientsForAuthorizationServer 

func (m *AuthorizationServerResource) ListOAuth2ClientsForAuthorizationServer(ctx context.Context, authServerId string) ([]*OAuth2Client, *Response, error)

func (*AuthorizationServerResource) ListOAuth2Scopes 

func (m *AuthorizationServerResource) ListOAuth2Scopes(ctx context.Context, authServerId string, qp *query.Params) ([]*OAuth2Scope, *Response, error)

func (*AuthorizationServerResource) ListRefreshTokensForAuthorizationServerAndClient 

func (m *AuthorizationServerResource) ListRefreshTokensForAuthorizationServerAndClient(ctx context.Context, authServerId string, clientId string, qp *query.Params) ([]*OAuth2RefreshToken, *Response, error)

func (*AuthorizationServerResource) RevokeRefreshTokenForAuthorizationServerAndClient 

func (m *AuthorizationServerResource) RevokeRefreshTokenForAuthorizationServerAndClient(ctx context.Context, authServerId string, clientId string, tokenId string) (*Response, error)

func (*AuthorizationServerResource) RevokeRefreshTokensForAuthorizationServerAndClient 

func (m *AuthorizationServerResource) RevokeRefreshTokensForAuthorizationServerAndClient(ctx context.Context, authServerId string, clientId string) (*Response, error)

func (*AuthorizationServerResource) RotateAuthorizationServerKeys 

func (m *AuthorizationServerResource) RotateAuthorizationServerKeys(ctx context.Context, authServerId string, body JwkUse) ([]*JsonWebKey, *Response, error)

func (*AuthorizationServerResource) UpdateAuthorizationServer 

func (m *AuthorizationServerResource) UpdateAuthorizationServer(ctx context.Context, authServerId string, body AuthorizationServer) (*AuthorizationServer, *Response, error)

func (*AuthorizationServerResource) UpdateAuthorizationServerPolicy 

func (m *AuthorizationServerResource) UpdateAuthorizationServerPolicy(ctx context.Context, authServerId string, policyId string, body AuthorizationServerPolicy) (*AuthorizationServerPolicy, *Response, error)

func (*AuthorizationServerResource) UpdateAuthorizationServerPolicyRule added in v2.5.2 

func (m *AuthorizationServerResource) UpdateAuthorizationServerPolicyRule(ctx context.Context, authServerId string, policyId string, ruleId string, body AuthorizationServerPolicyRule) (*AuthorizationServerPolicyRule, *Response, error)

Updates the configuration of the Policy Rule defined in the specified Custom Authorization Server and Policy.

func (*AuthorizationServerResource) UpdateOAuth2Claim 

func (m *AuthorizationServerResource) UpdateOAuth2Claim(ctx context.Context, authServerId string, claimId string, body OAuth2Claim) (*OAuth2Claim, *Response, error)

func (*AuthorizationServerResource) UpdateOAuth2Scope 

func (m *AuthorizationServerResource) UpdateOAuth2Scope(ctx context.Context, authServerId string, scopeId string, body OAuth2Scope) (*OAuth2Scope, *Response, error)

type AutoLoginApplication 

type AutoLoginApplication struct {
	Embedded      interface{}                   `json:"_embedded,omitempty"`
	Links         interface{}                   `json:"_links,omitempty"`
	Accessibility *ApplicationAccessibility     `json:"accessibility,omitempty"`
	Created       *time.Time                    `json:"created,omitempty"`
	Credentials   *SchemeApplicationCredentials `json:"credentials,omitempty"`
	Features      []string                      `json:"features,omitempty"`
	Id            string                        `json:"id,omitempty"`
	Label         string                        `json:"label,omitempty"`
	LastUpdated   *time.Time                    `json:"lastUpdated,omitempty"`
	Licensing     *ApplicationLicensing         `json:"licensing,omitempty"`
	Name          string                        `json:"name,omitempty"`
	Profile       interface{}                   `json:"profile,omitempty"`
	Settings      *AutoLoginApplicationSettings `json:"settings,omitempty"`
	SignOnMode    string                        `json:"signOnMode,omitempty"`
	Status        string                        `json:"status,omitempty"`
	Visibility    *ApplicationVisibility        `json:"visibility,omitempty"`
}

func NewAutoLoginApplication 

func NewAutoLoginApplication() *AutoLoginApplication

func (*AutoLoginApplication) IsApplicationInstance 

func (a *AutoLoginApplication) IsApplicationInstance() bool

type AutoLoginApplicationSettings 

type AutoLoginApplicationSettings struct {
	App                *ApplicationSettingsApplication     `json:"app,omitempty"`
	ImplicitAssignment *bool                               `json:"implicitAssignment,omitempty"`
	InlineHookId       string                              `json:"inlineHookId,omitempty"`
	Notes              *ApplicationSettingsNotes           `json:"notes,omitempty"`
	Notifications      *ApplicationSettingsNotifications   `json:"notifications,omitempty"`
	SignOn             *AutoLoginApplicationSettingsSignOn `json:"signOn,omitempty"`
}

type AutoLoginApplicationSettingsSignOn 

type AutoLoginApplicationSettingsSignOn struct {
	LoginUrl    string `json:"loginUrl,omitempty"`
	RedirectUrl string `json:"redirectUrl,omitempty"`
}

type BasicApplicationSettings 

type BasicApplicationSettings struct {
	App                *BasicApplicationSettingsApplication `json:"app,omitempty"`
	ImplicitAssignment *bool                                `json:"implicitAssignment,omitempty"`
	InlineHookId       string                               `json:"inlineHookId,omitempty"`
	Notes              *ApplicationSettingsNotes            `json:"notes,omitempty"`
	Notifications      *ApplicationSettingsNotifications    `json:"notifications,omitempty"`
}

type BasicApplicationSettingsApplication 

type BasicApplicationSettingsApplication struct {
	AuthURL string `json:"authURL,omitempty"`
	Url     string `json:"url,omitempty"`
}

type BasicAuthApplication 

type BasicAuthApplication struct {
	Embedded      interface{}                   `json:"_embedded,omitempty"`
	Links         interface{}                   `json:"_links,omitempty"`
	Accessibility *ApplicationAccessibility     `json:"accessibility,omitempty"`
	Created       *time.Time                    `json:"created,omitempty"`
	Credentials   *SchemeApplicationCredentials `json:"credentials,omitempty"`
	Features      []string                      `json:"features,omitempty"`
	Id            string                        `json:"id,omitempty"`
	Label         string                        `json:"label,omitempty"`
	LastUpdated   *time.Time                    `json:"lastUpdated,omitempty"`
	Licensing     *ApplicationLicensing         `json:"licensing,omitempty"`
	Name          string                        `json:"name,omitempty"`
	Profile       interface{}                   `json:"profile,omitempty"`
	Settings      *BasicApplicationSettings     `json:"settings,omitempty"`
	SignOnMode    string                        `json:"signOnMode,omitempty"`
	Status        string                        `json:"status,omitempty"`
	Visibility    *ApplicationVisibility        `json:"visibility,omitempty"`
}

func NewBasicAuthApplication 

func NewBasicAuthApplication() *BasicAuthApplication

func (*BasicAuthApplication) IsApplicationInstance 

func (a *BasicAuthApplication) IsApplicationInstance() bool

type BearerAuth added in v2.17.0 

type BearerAuth struct {
	// contains filtered or unexported fields
}

func NewBearerAuth added in v2.17.0 

func NewBearerAuth(token string, req *http.Request) *BearerAuth

func (*BearerAuth) Authorize added in v2.17.0 

func (a *BearerAuth) Authorize() error

type BeforeScheduledActionPolicyRuleCondition 

type BeforeScheduledActionPolicyRuleCondition struct {
	Duration        *Duration                     `json:"duration,omitempty"`
	LifecycleAction *ScheduledUserLifecycleAction `json:"lifecycleAction,omitempty"`
}

func NewBeforeScheduledActionPolicyRuleCondition added in v2.10.1 

func NewBeforeScheduledActionPolicyRuleCondition() *BeforeScheduledActionPolicyRuleCondition

func (*BeforeScheduledActionPolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *BeforeScheduledActionPolicyRuleCondition) IsPolicyInstance() bool

type BookmarkApplication 

type BookmarkApplication struct {
	Embedded      interface{}                  `json:"_embedded,omitempty"`
	Links         interface{}                  `json:"_links,omitempty"`
	Accessibility *ApplicationAccessibility    `json:"accessibility,omitempty"`
	Created       *time.Time                   `json:"created,omitempty"`
	Credentials   *ApplicationCredentials      `json:"credentials,omitempty"`
	Features      []string                     `json:"features,omitempty"`
	Id            string                       `json:"id,omitempty"`
	Label         string                       `json:"label,omitempty"`
	LastUpdated   *time.Time                   `json:"lastUpdated,omitempty"`
	Licensing     *ApplicationLicensing        `json:"licensing,omitempty"`
	Name          string                       `json:"name,omitempty"`
	Profile       interface{}                  `json:"profile,omitempty"`
	Settings      *BookmarkApplicationSettings `json:"settings,omitempty"`
	SignOnMode    string                       `json:"signOnMode,omitempty"`
	Status        string                       `json:"status,omitempty"`
	Visibility    *ApplicationVisibility       `json:"visibility,omitempty"`
}

func NewBookmarkApplication 

func NewBookmarkApplication() *BookmarkApplication

func (*BookmarkApplication) IsApplicationInstance 

func (a *BookmarkApplication) IsApplicationInstance() bool

type BookmarkApplicationSettings 

type BookmarkApplicationSettings struct {
	App                *BookmarkApplicationSettingsApplication `json:"app,omitempty"`
	ImplicitAssignment *bool                                   `json:"implicitAssignment,omitempty"`
	InlineHookId       string                                  `json:"inlineHookId,omitempty"`
	Notes              *ApplicationSettingsNotes               `json:"notes,omitempty"`
	Notifications      *ApplicationSettingsNotifications       `json:"notifications,omitempty"`
}

type BookmarkApplicationSettingsApplication 

type BookmarkApplicationSettingsApplication struct {
	RequestIntegration *bool  `json:"requestIntegration,omitempty"`
	Url                string `json:"url,omitempty"`
}

type Brand added in v2.9.1 

type Brand struct {
	Links                      interface{} `json:"_links,omitempty"`
	AgreeToCustomPrivacyPolicy *bool       `json:"agreeToCustomPrivacyPolicy,omitempty"`
	CustomPrivacyPolicyUrl     string      `json:"customPrivacyPolicyUrl,omitempty"`
	Id                         string      `json:"id,omitempty"`
	RemovePoweredByOkta        *bool       `json:"removePoweredByOkta,omitempty"`
}

type BrandResource added in v2.9.1 

type BrandResource resource

func (*BrandResource) CreateEmailTemplateCustomization added in v2.11.0 

func (m *BrandResource) CreateEmailTemplateCustomization(ctx context.Context, brandId string, templateName string, body EmailTemplateCustomizationRequest) (*EmailTemplateCustomization, *Response, error)

Create an email customization

func (*BrandResource) DeleteBrandThemeBackgroundImage added in v2.9.1 

func (m *BrandResource) DeleteBrandThemeBackgroundImage(ctx context.Context, brandId string, themeId string) (*Response, error)

Deletes a Theme background image

func (*BrandResource) DeleteBrandThemeFavicon added in v2.9.1 

func (m *BrandResource) DeleteBrandThemeFavicon(ctx context.Context, brandId string, themeId string) (*Response, error)

Deletes a Theme favicon. The org then uses the Okta default favicon. 

func (m *BrandResource) DeleteBrandThemeLogo(ctx context.Context, brandId string, themeId string) (*Response, error)

Deletes a Theme logo. The org then uses the Okta default logo.

func (*BrandResource) DeleteEmailTemplateCustomization added in v2.11.0 

func (m *BrandResource) DeleteEmailTemplateCustomization(ctx context.Context, brandId string, templateName string, customizationId string) (*Response, error)

Delete an email customization

func (*BrandResource) DeleteEmailTemplateCustomizations added in v2.11.0 

func (m *BrandResource) DeleteEmailTemplateCustomizations(ctx context.Context, brandId string, templateName string) (*Response, error)

Delete all customizations for an email template. Also known as “Reset to Default”.

func (*BrandResource) GetBrand added in v2.9.1 

func (m *BrandResource) GetBrand(ctx context.Context, brandId string) (*Brand, *Response, error)

Fetches a brand by `brandId`

func (*BrandResource) GetBrandTheme added in v2.9.1 

func (m *BrandResource) GetBrandTheme(ctx context.Context, brandId string, themeId string) (*ThemeResponse, *Response, error)

Fetches a theme for a brand

func (*BrandResource) GetEmailTemplate added in v2.11.0 

func (m *BrandResource) GetEmailTemplate(ctx context.Context, brandId string, templateName string) (*EmailTemplate, *Response, error)

Fetch an email template by templateName

func (*BrandResource) GetEmailTemplateCustomization added in v2.11.0 

func (m *BrandResource) GetEmailTemplateCustomization(ctx context.Context, brandId string, templateName string, customizationId string) (*EmailTemplateCustomization, *Response, error)

Fetch an email customization by id.

func (*BrandResource) GetEmailTemplateCustomizationPreview added in v2.11.0 

func (m *BrandResource) GetEmailTemplateCustomizationPreview(ctx context.Context, brandId string, templateName string, customizationId string) (*EmailTemplateContent, *Response, error)

Get a preview of an email template customization.

func (*BrandResource) GetEmailTemplateDefaultContent added in v2.11.0 

func (m *BrandResource) GetEmailTemplateDefaultContent(ctx context.Context, brandId string, templateName string) (*EmailTemplateContent, *Response, error)

Fetch the default content for an email template.

func (*BrandResource) GetEmailTemplateDefaultContentPreview added in v2.11.0 

func (m *BrandResource) GetEmailTemplateDefaultContentPreview(ctx context.Context, brandId string, templateName string) (*EmailTemplateContent, *Response, error)

Fetch a preview of an email template's default content by populating velocity references with the current user's environment.

func (*BrandResource) ListBrandThemes added in v2.9.1 

func (m *BrandResource) ListBrandThemes(ctx context.Context, brandId string) ([]*ThemeResponse, *Response, error)

List all the themes in your brand

func (*BrandResource) ListBrands added in v2.9.1 

func (m *BrandResource) ListBrands(ctx context.Context) ([]*Brand, *Response, error)

List all the brands in your org.

func (*BrandResource) ListEmailTemplateCustomizations added in v2.11.0 

func (m *BrandResource) ListEmailTemplateCustomizations(ctx context.Context, brandId string, templateName string) ([]*EmailTemplateCustomization, *Response, error)

List all email customizations for an email template

func (*BrandResource) ListEmailTemplates added in v2.11.0 

func (m *BrandResource) ListEmailTemplates(ctx context.Context, brandId string, qp *query.Params) ([]*EmailTemplate, *Response, error)

List email templates in your organization with pagination.

func (*BrandResource) SendTestEmail added in v2.11.0 

func (m *BrandResource) SendTestEmail(ctx context.Context, brandId string, templateName string, body EmailTemplateTestRequest) (*Response, error)

Send a test email to the current users primary and secondary email addresses. The email content is selected based on the following priority: An email customization specifically for the users locale. The default language of email customizations. The email templates default content.

func (*BrandResource) UpdateBrand added in v2.9.1 

func (m *BrandResource) UpdateBrand(ctx context.Context, brandId string, body Brand) (*Brand, *Response, error)

Updates a brand by `brandId`

func (*BrandResource) UpdateBrandTheme added in v2.9.1 

func (m *BrandResource) UpdateBrandTheme(ctx context.Context, brandId string, themeId string, body Theme) (*ThemeResponse, *Response, error)

Updates a theme for a brand

func (*BrandResource) UpdateEmailTemplateCustomization added in v2.11.0 

func (m *BrandResource) UpdateEmailTemplateCustomization(ctx context.Context, brandId string, templateName string, customizationId string, body EmailTemplateCustomizationRequest) (*EmailTemplateCustomization, *Response, error)

Update an email customization

func (*BrandResource) UploadBrandThemeBackgroundImage added in v2.9.1 

func (m *BrandResource) UploadBrandThemeBackgroundImage(ctx context.Context, brandId string, themeId string, file string) (*ImageUploadResponse, *Response, error)

Updates the background image for your Theme

func (*BrandResource) UploadBrandThemeFavicon added in v2.9.1 

func (m *BrandResource) UploadBrandThemeFavicon(ctx context.Context, brandId string, themeId string, file string) (*ImageUploadResponse, *Response, error)

Updates the favicon for your theme 

func (m *BrandResource) UploadBrandThemeLogo(ctx context.Context, brandId string, themeId string, file string) (*ImageUploadResponse, *Response, error)

Updates the logo for your Theme

type BrowserPluginApplication 

type BrowserPluginApplication struct {
	Embedded      interface{}                   `json:"_embedded,omitempty"`
	Links         interface{}                   `json:"_links,omitempty"`
	Accessibility *ApplicationAccessibility     `json:"accessibility,omitempty"`
	Created       *time.Time                    `json:"created,omitempty"`
	Credentials   *SchemeApplicationCredentials `json:"credentials,omitempty"`
	Features      []string                      `json:"features,omitempty"`
	Id            string                        `json:"id,omitempty"`
	Label         string                        `json:"label,omitempty"`
	LastUpdated   *time.Time                    `json:"lastUpdated,omitempty"`
	Licensing     *ApplicationLicensing         `json:"licensing,omitempty"`
	Name          string                        `json:"name,omitempty"`
	Profile       interface{}                   `json:"profile,omitempty"`
	Settings      *ApplicationSettings          `json:"settings,omitempty"`
	SignOnMode    string                        `json:"signOnMode,omitempty"`
	Status        string                        `json:"status,omitempty"`
	Visibility    *ApplicationVisibility        `json:"visibility,omitempty"`
}

func NewBrowserPluginApplication 

func NewBrowserPluginApplication() *BrowserPluginApplication

func (*BrowserPluginApplication) IsApplicationInstance 

func (a *BrowserPluginApplication) IsApplicationInstance() bool

type CallUserFactor 

type CallUserFactor struct {
	Embedded    interface{}            `json:"_embedded,omitempty"`
	Links       interface{}            `json:"_links,omitempty"`
	Created     *time.Time             `json:"created,omitempty"`
	FactorType  string                 `json:"factorType,omitempty"`
	Id          string                 `json:"id,omitempty"`
	LastUpdated *time.Time             `json:"lastUpdated,omitempty"`
	Provider    string                 `json:"provider,omitempty"`
	Status      string                 `json:"status,omitempty"`
	Verify      *VerifyFactorRequest   `json:"verify,omitempty"`
	Profile     *CallUserFactorProfile `json:"profile,omitempty"`
}

func NewCallUserFactor 

func NewCallUserFactor() *CallUserFactor

func (*CallUserFactor) IsUserFactorInstance 

func (a *CallUserFactor) IsUserFactorInstance() bool

type CallUserFactorProfile 

type CallUserFactorProfile struct {
	PhoneExtension string `json:"phoneExtension,omitempty"`
	PhoneNumber    string `json:"phoneNumber,omitempty"`
}

func NewCallUserFactorProfile 

func NewCallUserFactorProfile() *CallUserFactorProfile

func (*CallUserFactorProfile) IsUserFactorInstance 

func (a *CallUserFactorProfile) IsUserFactorInstance() bool

type CapabilitiesCreateObject added in v2.10.0 

type CapabilitiesCreateObject struct {
	LifecycleCreate *LifecycleCreateSettingObject `json:"lifecycleCreate,omitempty"`
}

func NewCapabilitiesCreateObject added in v2.10.0 

func NewCapabilitiesCreateObject() *CapabilitiesCreateObject

func (*CapabilitiesCreateObject) IsApplicationInstance added in v2.10.0 

func (a *CapabilitiesCreateObject) IsApplicationInstance() bool

type CapabilitiesObject added in v2.10.0 

type CapabilitiesObject struct {
	Create *CapabilitiesCreateObject `json:"create,omitempty"`
	Update *CapabilitiesUpdateObject `json:"update,omitempty"`
}

func NewCapabilitiesObject added in v2.10.0 

func NewCapabilitiesObject() *CapabilitiesObject

func (*CapabilitiesObject) IsApplicationInstance added in v2.10.0 

func (a *CapabilitiesObject) IsApplicationInstance() bool

type CapabilitiesUpdateObject added in v2.10.0 

type CapabilitiesUpdateObject struct {
	LifecycleDeactivate *LifecycleDeactivateSettingObject `json:"lifecycleDeactivate,omitempty"`
	Password            *PasswordSettingObject            `json:"password,omitempty"`
	Profile             *ProfileSettingObject             `json:"profile,omitempty"`
}

func NewCapabilitiesUpdateObject added in v2.10.0 

func NewCapabilitiesUpdateObject() *CapabilitiesUpdateObject

func (*CapabilitiesUpdateObject) IsApplicationInstance added in v2.10.0 

func (a *CapabilitiesUpdateObject) IsApplicationInstance() bool

type CatalogApplication added in v2.1.0 

type CatalogApplication struct {
	Links              interface{} `json:"_links,omitempty"`
	Category           string      `json:"category,omitempty"`
	Description        string      `json:"description,omitempty"`
	DisplayName        string      `json:"displayName,omitempty"`
	Features           []string    `json:"features,omitempty"`
	Id                 string      `json:"id,omitempty"`
	LastUpdated        *time.Time  `json:"lastUpdated,omitempty"`
	Name               string      `json:"name,omitempty"`
	SignOnModes        []string    `json:"signOnModes,omitempty"`
	Status             string      `json:"status,omitempty"`
	VerificationStatus string      `json:"verificationStatus,omitempty"`
	Website            string      `json:"website,omitempty"`
}

type CatalogApplicationStatus added in v2.1.0 

type CatalogApplicationStatus string

type ChangeEnum added in v2.10.0 

type ChangeEnum string

type ChangePasswordRequest 

type ChangePasswordRequest struct {
	NewPassword *PasswordCredential `json:"newPassword,omitempty"`
	OldPassword *PasswordCredential `json:"oldPassword,omitempty"`
}

type ChannelBinding added in v2.9.1 

type ChannelBinding struct {
	Required string `json:"required,omitempty"`
	Style    string `json:"style,omitempty"`
}

type Client 

type Client struct {
	Application                *ApplicationResource
	Authenticator              *AuthenticatorResource
	AuthorizationServer        *AuthorizationServerResource
	Brand                      *BrandResource
	Domain                     *DomainResource
	EventHook                  *EventHookResource
	Feature                    *FeatureResource
	Group                      *GroupResource
	GroupSchema                *GroupSchemaResource
	IdentityProvider           *IdentityProviderResource
	InlineHook                 *InlineHookResource
	LinkedObject               *LinkedObjectResource
	LogEvent                   *LogEventResource
	NetworkZone                *NetworkZoneResource
	OrgSetting                 *OrgSettingResource
	Policy                     *PolicyResource
	ProfileMapping             *ProfileMappingResource
	Session                    *SessionResource
	SmsTemplate                *SmsTemplateResource
	Subscription               *SubscriptionResource
	ThreatInsightConfiguration *ThreatInsightConfigurationResource
	TrustedOrigin              *TrustedOriginResource
	User                       *UserResource
	UserFactor                 *UserFactorResource
	UserSchema                 *UserSchemaResource
	UserType                   *UserTypeResource
	// contains filtered or unexported fields
}

func ClientFromContext 

func ClientFromContext(ctx context.Context) (*Client, bool)

func NewClient 

func NewClient(ctx context.Context, conf ...ConfigSetter) (context.Context, *Client, error)

func (*Client) CloneRequestExecutor added in v2.6.2 

func (c *Client) CloneRequestExecutor() *RequestExecutor

CloneRequestExecutor create a clone of the underlying request executor

func (*Client) GetConfig 

func (c *Client) GetConfig() *config

func (*Client) GetRequestExecutor 

func (c *Client) GetRequestExecutor() *RequestExecutor

GetRequestExecutor returns underlying request executor Deprecated: please use CloneRequestExecutor() to avoid race conditions

func (*Client) SetConfig added in v2.17.0 

func (c *Client) SetConfig(conf ...ConfigSetter) (err error)

type ClientAssertionClaims 

type ClientAssertionClaims struct {
	Issuer   string           `json:"iss,omitempty"`
	Subject  string           `json:"sub,omitempty"`
	Audience string           `json:"aud,omitempty"`
	Expiry   *jwt.NumericDate `json:"exp,omitempty"`
	IssuedAt *jwt.NumericDate `json:"iat,omitempty"`
	ID       string           `json:"jti,omitempty"`
}

type ClientPolicyCondition 

type ClientPolicyCondition struct {
	Include []string `json:"include,omitempty"`
}

func NewClientPolicyCondition added in v2.10.1 

func NewClientPolicyCondition() *ClientPolicyCondition

func (*ClientPolicyCondition) IsPolicyInstance added in v2.10.1 

func (a *ClientPolicyCondition) IsPolicyInstance() bool

type ClientSecret added in v2.15.0 

type ClientSecret struct {
	Links        interface{} `json:"_links,omitempty"`
	ClientSecret string      `json:"client_secret,omitempty"`
	Created      *time.Time  `json:"created,omitempty"`
	Id           string      `json:"id,omitempty"`
	LastUpdated  *time.Time  `json:"lastUpdated,omitempty"`
	SecretHash   string      `json:"secret_hash,omitempty"`
	Status       string      `json:"status,omitempty"`
}

func NewClientSecret added in v2.15.0 

func NewClientSecret() *ClientSecret

func (*ClientSecret) IsApplicationInstance added in v2.15.0 

func (a *ClientSecret) IsApplicationInstance() bool

type ClientSecretMetadata added in v2.15.0 

type ClientSecretMetadata struct {
	ClientSecret string `json:"client_secret,omitempty"`
}

func NewClientSecretMetadata added in v2.15.0 

func NewClientSecretMetadata() *ClientSecretMetadata

func (*ClientSecretMetadata) IsApplicationInstance added in v2.15.0 

func (a *ClientSecretMetadata) IsApplicationInstance() bool

type Compliance added in v2.9.1 

type Compliance struct {
	Fips string `json:"fips,omitempty"`
}

type ConfigSetter 

type ConfigSetter func(*config)

func WithAuthorizationMode 

func WithAuthorizationMode(authzMode string) ConfigSetter

func WithCache 

func WithCache(cache bool) ConfigSetter

func WithCacheManager 

func WithCacheManager(cacheManager cache.Cache) ConfigSetter

func WithCacheTti 

func WithCacheTti(i int32) ConfigSetter

func WithCacheTtl 

func WithCacheTtl(i int32) ConfigSetter

func WithClientAssertion added in v2.17.0 

func WithClientAssertion(clientAssertion string) ConfigSetter

func WithClientId 

func WithClientId(clientId string) ConfigSetter

func WithConnectionTimeout 

func WithConnectionTimeout(i int64) ConfigSetter

func WithHttpClient deprecated 

func WithHttpClient(httpClient http.Client) ConfigSetter

Deprecated: please use WithHttpClientPtr method

func WithHttpClientPtr added in v2.3.1 

func WithHttpClientPtr(httpClient *http.Client) ConfigSetter

func WithHttpInterceptorAndHttpClientPtr added in v2.18.0 

func WithHttpInterceptorAndHttpClientPtr(interceptor func(*http.Request) error, httpClient *http.Client, blocking bool) ConfigSetter

func WithOrgUrl 

func WithOrgUrl(url string) ConfigSetter

func WithPrivateKey 

func WithPrivateKey(privateKey string) ConfigSetter

WithPrivateKey sets private key key. Can be either a path to a private key or private key itself.

func WithPrivateKeyId added in v2.13.0 

func WithPrivateKeyId(privateKeyId string) ConfigSetter

func WithPrivateKeySigner added in v2.3.1 

func WithPrivateKeySigner(signer jose.Signer) ConfigSetter

func WithProxyHost 

func WithProxyHost(host string) ConfigSetter

func WithProxyPassword 

func WithProxyPassword(pass string) ConfigSetter

func WithProxyPort 

func WithProxyPort(i int32) ConfigSetter

func WithProxyUsername 

func WithProxyUsername(username string) ConfigSetter

func WithRateLimitMaxBackOff added in v2.2.0 

func WithRateLimitMaxBackOff(maxBackoff int64) ConfigSetter

func WithRateLimitMaxRetries 

func WithRateLimitMaxRetries(maxRetries int32) ConfigSetter

func WithRequestTimeout 

func WithRequestTimeout(requestTimeout int64) ConfigSetter

func WithScopes 

func WithScopes(scopes []string) ConfigSetter

func WithTestingDisableHttpsCheck 

func WithTestingDisableHttpsCheck(httpsCheck bool) ConfigSetter

func WithToken 

func WithToken(token string) ConfigSetter

func WithUserAgentExtra 

func WithUserAgentExtra(userAgent string) ConfigSetter

type ContextPolicyRuleCondition 

type ContextPolicyRuleCondition struct {
	Expression string `json:"expression,omitempty"`
}

func NewContextPolicyRuleCondition added in v2.10.1 

func NewContextPolicyRuleCondition() *ContextPolicyRuleCondition

func (*ContextPolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *ContextPolicyRuleCondition) IsPolicyInstance() bool

type CreateSessionRequest 

type CreateSessionRequest struct {
	SessionToken string `json:"sessionToken,omitempty"`
}

type CreateUserRequest 

type CreateUserRequest struct {
	Credentials *UserCredentials `json:"credentials,omitempty"`
	GroupIds    []string         `json:"groupIds,omitempty"`
	Profile     *UserProfile     `json:"profile,omitempty"`
	Type        *UserType        `json:"type,omitempty"`
}

type Csr 

type Csr struct {
	Created *time.Time `json:"created,omitempty"`
	Csr     string     `json:"csr,omitempty"`
	Id      string     `json:"id,omitempty"`
	Kty     string     `json:"kty,omitempty"`
}

type CsrMetadata 

type CsrMetadata struct {
	Subject         *CsrMetadataSubject         `json:"subject,omitempty"`
	SubjectAltNames *CsrMetadataSubjectAltNames `json:"subjectAltNames,omitempty"`
}

type CsrMetadataSubject 

type CsrMetadataSubject struct {
	CommonName             string `json:"commonName,omitempty"`
	CountryName            string `json:"countryName,omitempty"`
	LocalityName           string `json:"localityName,omitempty"`
	OrganizationName       string `json:"organizationName,omitempty"`
	OrganizationalUnitName string `json:"organizationalUnitName,omitempty"`
	StateOrProvinceName    string `json:"stateOrProvinceName,omitempty"`
}

type CsrMetadataSubjectAltNames 

type CsrMetadataSubjectAltNames struct {
	DnsNames []string `json:"dnsNames,omitempty"`
}

type CustomHotpUserFactor added in v2.1.0 

type CustomHotpUserFactor struct {
	Embedded        interface{}                  `json:"_embedded,omitempty"`
	Links           interface{}                  `json:"_links,omitempty"`
	Created         *time.Time                   `json:"created,omitempty"`
	FactorType      string                       `json:"factorType,omitempty"`
	Id              string                       `json:"id,omitempty"`
	LastUpdated     *time.Time                   `json:"lastUpdated,omitempty"`
	Provider        string                       `json:"provider,omitempty"`
	Status          string                       `json:"status,omitempty"`
	Verify          *VerifyFactorRequest         `json:"verify,omitempty"`
	FactorProfileId string                       `json:"factorProfileId,omitempty"`
	Profile         *CustomHotpUserFactorProfile `json:"profile,omitempty"`
}

func NewCustomHotpUserFactor added in v2.1.0 

func NewCustomHotpUserFactor() *CustomHotpUserFactor

func (*CustomHotpUserFactor) IsUserFactorInstance added in v2.1.0 

func (a *CustomHotpUserFactor) IsUserFactorInstance() bool

type CustomHotpUserFactorProfile added in v2.1.0 

type CustomHotpUserFactorProfile struct {
	SharedSecret string `json:"sharedSecret,omitempty"`
}

func NewCustomHotpUserFactorProfile added in v2.1.0 

func NewCustomHotpUserFactorProfile() *CustomHotpUserFactorProfile

func (*CustomHotpUserFactorProfile) IsUserFactorInstance added in v2.1.0 

func (a *CustomHotpUserFactorProfile) IsUserFactorInstance() bool

type DNSRecord added in v2.5.2 

type DNSRecord struct {
	Expiration string   `json:"expiration,omitempty"`
	Fqdn       string   `json:"fqdn,omitempty"`
	RecordType string   `json:"recordType,omitempty"`
	Values     []string `json:"values,omitempty"`
}

type DNSRecordType added in v2.5.2 

type DNSRecordType string

type DeviceAccessPolicyRuleCondition added in v2.9.1 

type DeviceAccessPolicyRuleCondition struct {
	Migrated   *bool                              `json:"migrated,omitempty"`
	Platform   *DevicePolicyRuleConditionPlatform `json:"platform,omitempty"`
	Rooted     *bool                              `json:"rooted,omitempty"`
	TrustLevel string                             `json:"trustLevel,omitempty"`
	Managed    *bool                              `json:"managed,omitempty"`
	Registered *bool                              `json:"registered,omitempty"`
}

func NewDeviceAccessPolicyRuleCondition added in v2.10.1 

func NewDeviceAccessPolicyRuleCondition() *DeviceAccessPolicyRuleCondition

func (*DeviceAccessPolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *DeviceAccessPolicyRuleCondition) IsPolicyInstance() bool

type DevicePolicyRuleCondition 

type DevicePolicyRuleCondition struct {
	Migrated   *bool                              `json:"migrated,omitempty"`
	Platform   *DevicePolicyRuleConditionPlatform `json:"platform,omitempty"`
	Rooted     *bool                              `json:"rooted,omitempty"`
	TrustLevel string                             `json:"trustLevel,omitempty"`
}

func NewDevicePolicyRuleCondition added in v2.10.1 

func NewDevicePolicyRuleCondition() *DevicePolicyRuleCondition

func (*DevicePolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *DevicePolicyRuleCondition) IsPolicyInstance() bool

type DevicePolicyRuleConditionPlatform 

type DevicePolicyRuleConditionPlatform struct {
	SupportedMDMFrameworks []string `json:"supportedMDMFrameworks,omitempty"`
	Types                  []string `json:"types,omitempty"`
}

func NewDevicePolicyRuleConditionPlatform added in v2.10.1 

func NewDevicePolicyRuleConditionPlatform() *DevicePolicyRuleConditionPlatform

func (*DevicePolicyRuleConditionPlatform) IsPolicyInstance added in v2.10.1 

func (a *DevicePolicyRuleConditionPlatform) IsPolicyInstance() bool

type Domain added in v2.5.2 

type Domain struct {
	CertificateSourceType string                     `json:"certificateSourceType,omitempty"`
	DnsRecords            []*DNSRecord               `json:"dnsRecords,omitempty"`
	Domain                string                     `json:"domain,omitempty"`
	Id                    string                     `json:"id,omitempty"`
	PublicCertificate     *DomainCertificateMetadata `json:"publicCertificate,omitempty"`
	ValidationStatus      string                     `json:"validationStatus,omitempty"`
}

type DomainCertificate added in v2.5.2 

type DomainCertificate struct {
	Certificate      string `json:"certificate,omitempty"`
	CertificateChain string `json:"certificateChain,omitempty"`
	PrivateKey       string `json:"privateKey,omitempty"`
	Type             string `json:"type,omitempty"`
}

type DomainCertificateMetadata added in v2.5.2 

type DomainCertificateMetadata struct {
	Expiration  string `json:"expiration,omitempty"`
	Fingerprint string `json:"fingerprint,omitempty"`
	Subject     string `json:"subject,omitempty"`
}

type DomainCertificateResource added in v2.5.2 

type DomainCertificateResource resource

type DomainCertificateSourceType added in v2.5.2 

type DomainCertificateSourceType string

type DomainCertificateType added in v2.5.2 

type DomainCertificateType string

type DomainListResponse added in v2.5.2 

type DomainListResponse struct {
	Domains []*Domain `json:"domains,omitempty"`
}

type DomainResource added in v2.5.2 

type DomainResource resource

func (*DomainResource) CreateCertificate added in v2.5.2 

func (m *DomainResource) CreateCertificate(ctx context.Context, domainId string, body DomainCertificate) (*Response, error)

Creates the Certificate for the Domain.

func (*DomainResource) CreateDomain added in v2.5.2 

func (m *DomainResource) CreateDomain(ctx context.Context, body Domain) (*Domain, *Response, error)

Creates your domain.

func (*DomainResource) DeleteDomain added in v2.5.2 

func (m *DomainResource) DeleteDomain(ctx context.Context, domainId string) (*Response, error)

Deletes a Domain by `id`.

func (*DomainResource) GetDomain added in v2.5.2 

func (m *DomainResource) GetDomain(ctx context.Context, domainId string) (*Domain, *Response, error)

Fetches a Domain by `id`.

func (*DomainResource) ListDomains added in v2.5.2 

func (m *DomainResource) ListDomains(ctx context.Context) (*DomainListResponse, *Response, error)

List all verified custom Domains for the org.

func (*DomainResource) VerifyDomain added in v2.5.2 

func (m *DomainResource) VerifyDomain(ctx context.Context, domainId string) (*Domain, *Response, error)

Verifies the Domain by `id`.

type DomainValidationStatus added in v2.5.2 

type DomainValidationStatus string

type Duration 

type Duration struct {
	Number    int64  `json:"-"`
	NumberPtr *int64 `json:"number,omitempty"`
	Unit      string `json:"unit,omitempty"`
}

func NewDuration added in v2.10.1 

func NewDuration() *Duration

func (*Duration) IsPolicyInstance added in v2.10.1 

func (a *Duration) IsPolicyInstance() bool

func (*Duration) MarshalJSON added in v2.17.0 

func (a *Duration) MarshalJSON() ([]byte, error)

func (*Duration) UnmarshalJSON added in v2.17.0 

func (a *Duration) UnmarshalJSON(data []byte) error

type EmailTemplate added in v2.11.0 

type EmailTemplate struct {
	Links interface{} `json:"_links,omitempty"`
	Name  string      `json:"name,omitempty"`
}

type EmailTemplateContent added in v2.11.0 

type EmailTemplateContent struct {
	Links       interface{} `json:"_links,omitempty"`
	Body        string      `json:"body,omitempty"`
	FromAddress string      `json:"fromAddress,omitempty"`
	FromName    string      `json:"fromName,omitempty"`
	Subject     string      `json:"subject,omitempty"`
}

type EmailTemplateCustomization added in v2.11.0 

type EmailTemplateCustomization struct {
	Links       interface{} `json:"_links,omitempty"`
	Body        string      `json:"body,omitempty"`
	Created     *time.Time  `json:"created,omitempty"`
	Id          string      `json:"id,omitempty"`
	IsDefault   *bool       `json:"isDefault,omitempty"`
	Language    string      `json:"language,omitempty"`
	LastUpdated *time.Time  `json:"lastUpdated,omitempty"`
	Subject     string      `json:"subject,omitempty"`
}

type EmailTemplateCustomizationRequest added in v2.11.0 

type EmailTemplateCustomizationRequest struct {
	Body      string `json:"body,omitempty"`
	IsDefault *bool  `json:"isDefault,omitempty"`
	Language  string `json:"language,omitempty"`
	Subject   string `json:"subject,omitempty"`
}

type EmailTemplateResource added in v2.11.0 

type EmailTemplateResource resource

func (*EmailTemplateResource) GetEmailTemplate added in v2.11.0 

func (m *EmailTemplateResource) GetEmailTemplate(ctx context.Context, brandId string, templateName string) (*EmailTemplate, *Response, error)

Fetch an email template by templateName

type EmailTemplateTestRequest added in v2.11.0 

type EmailTemplateTestRequest struct {
	CustomizationId string `json:"customizationId,omitempty"`
}

type EmailTemplateTouchPointVariant added in v2.9.1 

type EmailTemplateTouchPointVariant string

type EmailUserFactor 

type EmailUserFactor struct {
	Embedded    interface{}             `json:"_embedded,omitempty"`
	Links       interface{}             `json:"_links,omitempty"`
	Created     *time.Time              `json:"created,omitempty"`
	FactorType  string                  `json:"factorType,omitempty"`
	Id          string                  `json:"id,omitempty"`
	LastUpdated *time.Time              `json:"lastUpdated,omitempty"`
	Provider    string                  `json:"provider,omitempty"`
	Status      string                  `json:"status,omitempty"`
	Verify      *VerifyFactorRequest    `json:"verify,omitempty"`
	Profile     *EmailUserFactorProfile `json:"profile,omitempty"`
}

func NewEmailUserFactor 

func NewEmailUserFactor() *EmailUserFactor

func (*EmailUserFactor) IsUserFactorInstance 

func (a *EmailUserFactor) IsUserFactorInstance() bool

type EmailUserFactorProfile 

type EmailUserFactorProfile struct {
	Email string `json:"email,omitempty"`
}

func NewEmailUserFactorProfile 

func NewEmailUserFactorProfile() *EmailUserFactorProfile

func (*EmailUserFactorProfile) IsUserFactorInstance 

func (a *EmailUserFactorProfile) IsUserFactorInstance() bool

type EnabledStatus 

type EnabledStatus string

type EndUserDashboardTouchPointVariant added in v2.9.1 

type EndUserDashboardTouchPointVariant string

type Error 

type Error struct {
	ErrorMessage     string                   `json:"error"`
	ErrorDescription string                   `json:"error_description"`
	ErrorCode        string                   `json:"errorCode,omitempty"`
	ErrorSummary     string                   `json:"errorSummary,omitempty" toml:"error_description"`
	ErrorLink        string                   `json:"errorLink,omitempty"`
	ErrorId          string                   `json:"errorId,omitempty"`
	ErrorCauses      []map[string]interface{} `json:"errorCauses,omitempty"`
}

func (*Error) Error 

func (e *Error) Error() string

type ErrorPageTouchPointVariant added in v2.9.1 

type ErrorPageTouchPointVariant string

type EventHook 

type EventHook struct {
	Links              interface{}         `json:"_links,omitempty"`
	Channel            *EventHookChannel   `json:"channel,omitempty"`
	Created            *time.Time          `json:"created,omitempty"`
	CreatedBy          string              `json:"createdBy,omitempty"`
	Events             *EventSubscriptions `json:"events,omitempty"`
	Id                 string              `json:"id,omitempty"`
	LastUpdated        *time.Time          `json:"lastUpdated,omitempty"`
	Name               string              `json:"name,omitempty"`
	Status             string              `json:"status,omitempty"`
	VerificationStatus string              `json:"verificationStatus,omitempty"`
}

type EventHookChannel 

type EventHookChannel struct {
	Config  *EventHookChannelConfig `json:"config,omitempty"`
	Type    string                  `json:"type,omitempty"`
	Version string                  `json:"version,omitempty"`
}

type EventHookChannelConfig 

type EventHookChannelConfig struct {
	AuthScheme *EventHookChannelConfigAuthScheme `json:"authScheme,omitempty"`
	Headers    []*EventHookChannelConfigHeader   `json:"headers,omitempty"`
	Uri        string                            `json:"uri,omitempty"`
}

type EventHookChannelConfigAuthScheme 

type EventHookChannelConfigAuthScheme struct {
	Key   string `json:"key,omitempty"`
	Type  string `json:"type,omitempty"`
	Value string `json:"value,omitempty"`
}

type EventHookChannelConfigAuthSchemeType 

type EventHookChannelConfigAuthSchemeType string

type EventHookChannelConfigHeader 

type EventHookChannelConfigHeader struct {
	Key   string `json:"key,omitempty"`
	Value string `json:"value,omitempty"`
}

type EventHookResource 

type EventHookResource resource

func (*EventHookResource) ActivateEventHook 

func (m *EventHookResource) ActivateEventHook(ctx context.Context, eventHookId string) (*EventHook, *Response, error)

func (*EventHookResource) CreateEventHook 

func (m *EventHookResource) CreateEventHook(ctx context.Context, body EventHook) (*EventHook, *Response, error)

func (*EventHookResource) DeactivateEventHook 

func (m *EventHookResource) DeactivateEventHook(ctx context.Context, eventHookId string) (*EventHook, *Response, error)

func (*EventHookResource) DeleteEventHook 

func (m *EventHookResource) DeleteEventHook(ctx context.Context, eventHookId string) (*Response, error)

func (*EventHookResource) GetEventHook 

func (m *EventHookResource) GetEventHook(ctx context.Context, eventHookId string) (*EventHook, *Response, error)

func (*EventHookResource) ListEventHooks 

func (m *EventHookResource) ListEventHooks(ctx context.Context) ([]*EventHook, *Response, error)

func (*EventHookResource) UpdateEventHook 

func (m *EventHookResource) UpdateEventHook(ctx context.Context, eventHookId string, body EventHook) (*EventHook, *Response, error)

func (*EventHookResource) VerifyEventHook 

func (m *EventHookResource) VerifyEventHook(ctx context.Context, eventHookId string) (*EventHook, *Response, error)

type EventSubscriptions 

type EventSubscriptions struct {
	Items []string `json:"items,omitempty"`
	Type  string   `json:"type,omitempty"`
}

type Factor 

type Factor interface {
	IsUserFactorInstance() bool
}

type FactorProvider 

type FactorProvider string

type FactorResultType 

type FactorResultType string

type FactorStatus 

type FactorStatus string

type FactorType 

type FactorType string

type Feature 

type Feature struct {
	Links       interface{}   `json:"_links,omitempty"`
	Description string        `json:"description,omitempty"`
	Id          string        `json:"id,omitempty"`
	Name        string        `json:"name,omitempty"`
	Stage       *FeatureStage `json:"stage,omitempty"`
	Status      string        `json:"status,omitempty"`
	Type        string        `json:"type,omitempty"`
}

type FeatureResource 

type FeatureResource resource

func (*FeatureResource) GetFeature 

func (m *FeatureResource) GetFeature(ctx context.Context, featureId string) (*Feature, *Response, error)

func (*FeatureResource) ListFeatureDependencies 

func (m *FeatureResource) ListFeatureDependencies(ctx context.Context, featureId string) ([]*Feature, *Response, error)

func (*FeatureResource) ListFeatureDependents 

func (m *FeatureResource) ListFeatureDependents(ctx context.Context, featureId string) ([]*Feature, *Response, error)

func (*FeatureResource) ListFeatures 

func (m *FeatureResource) ListFeatures(ctx context.Context) ([]*Feature, *Response, error)

func (*FeatureResource) UpdateFeatureLifecycle 

func (m *FeatureResource) UpdateFeatureLifecycle(ctx context.Context, featureId string, lifecycle string, qp *query.Params) (*Feature, *Response, error)

type FeatureStage 

type FeatureStage struct {
	State string `json:"state,omitempty"`
	Value string `json:"value,omitempty"`
}

type FeatureStageState 

type FeatureStageState string

type FeatureStageValue 

type FeatureStageValue string

type FeatureType 

type FeatureType string

type FipsEnum added in v2.9.1 

type FipsEnum string

type ForgotPasswordResponse 

type ForgotPasswordResponse struct {
	ResetPasswordUrl string `json:"resetPasswordUrl,omitempty"`
}

type GrantTypePolicyRuleCondition 

type GrantTypePolicyRuleCondition struct {
	Include []string `json:"include,omitempty"`
}

func NewGrantTypePolicyRuleCondition added in v2.10.1 

func NewGrantTypePolicyRuleCondition() *GrantTypePolicyRuleCondition

func (*GrantTypePolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *GrantTypePolicyRuleCondition) IsPolicyInstance() bool

type Group 

type Group struct {
	Embedded              interface{}   `json:"_embedded,omitempty"`
	Links                 interface{}   `json:"_links,omitempty"`
	Created               *time.Time    `json:"created,omitempty"`
	Id                    string        `json:"id,omitempty"`
	LastMembershipUpdated *time.Time    `json:"lastMembershipUpdated,omitempty"`
	LastUpdated           *time.Time    `json:"lastUpdated,omitempty"`
	ObjectClass           []string      `json:"objectClass,omitempty"`
	Profile               *GroupProfile `json:"profile,omitempty"`
	Type                  string        `json:"type,omitempty"`
}

type GroupCondition 

type GroupCondition struct {
	Exclude []string `json:"exclude,omitempty"`
	Include []string `json:"include,omitempty"`
}

func NewGroupCondition added in v2.10.1 

func NewGroupCondition() *GroupCondition

func (*GroupCondition) IsPolicyInstance added in v2.10.1 

func (a *GroupCondition) IsPolicyInstance() bool

type GroupPolicyRuleCondition 

type GroupPolicyRuleCondition struct {
	Exclude []string `json:"exclude,omitempty"`
	Include []string `json:"include,omitempty"`
}

func NewGroupPolicyRuleCondition added in v2.10.1 

func NewGroupPolicyRuleCondition() *GroupPolicyRuleCondition

func (*GroupPolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *GroupPolicyRuleCondition) IsPolicyInstance() bool

type GroupProfile 

type GroupProfile struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	GroupProfileMap
}

func (GroupProfile) MarshalJSON added in v2.9.2 

func (a GroupProfile) MarshalJSON() ([]byte, error)

func (*GroupProfile) UnmarshalJSON added in v2.9.2 

func (a *GroupProfile) UnmarshalJSON(data []byte) error

type GroupProfileMap added in v2.9.2 

type GroupProfileMap map[string]interface{}

type GroupResource 

type GroupResource resource

func (*GroupResource) ActivateGroupRule 

func (m *GroupResource) ActivateGroupRule(ctx context.Context, ruleId string) (*Response, error)

Activates a specific group rule by id from your organization

func (*GroupResource) AddApplicationInstanceTargetToAppAdminRoleGivenToGroup 

func (m *GroupResource) AddApplicationInstanceTargetToAppAdminRoleGivenToGroup(ctx context.Context, groupId string, roleId string, appName string, applicationId string) (*Response, error)

Add App Instance Target to App Administrator Role given to a Group

func (*GroupResource) AddApplicationTargetToAdminRoleGivenToGroup 

func (m *GroupResource) AddApplicationTargetToAdminRoleGivenToGroup(ctx context.Context, groupId string, roleId string, appName string) (*Response, error)

func (*GroupResource) AddGroupTargetToGroupAdministratorRoleForGroup 

func (m *GroupResource) AddGroupTargetToGroupAdministratorRoleForGroup(ctx context.Context, groupId string, roleId string, targetGroupId string) (*Response, error)

func (*GroupResource) AddUserToGroup 

func (m *GroupResource) AddUserToGroup(ctx context.Context, groupId string, userId string) (*Response, error)

Adds a user to a group with 'OKTA_GROUP' type.

func (*GroupResource) AssignRoleToGroup 

func (m *GroupResource) AssignRoleToGroup(ctx context.Context, groupId string, body AssignRoleRequest, qp *query.Params) (*Role, *Response, error)

Assigns a Role to a Group

func (*GroupResource) CreateGroup 

func (m *GroupResource) CreateGroup(ctx context.Context, body Group) (*Group, *Response, error)

Adds a new group with `OKTA_GROUP` type to your organization.

func (*GroupResource) CreateGroupRule 

func (m *GroupResource) CreateGroupRule(ctx context.Context, body GroupRule) (*GroupRule, *Response, error)

Creates a group rule to dynamically add users to the specified group if they match the condition

func (*GroupResource) DeactivateGroupRule 

func (m *GroupResource) DeactivateGroupRule(ctx context.Context, ruleId string) (*Response, error)

Deactivates a specific group rule by id from your organization

func (*GroupResource) DeleteGroup 

func (m *GroupResource) DeleteGroup(ctx context.Context, groupId string) (*Response, error)

Removes a group with `OKTA_GROUP` type from your organization.

func (*GroupResource) DeleteGroupRule 

func (m *GroupResource) DeleteGroupRule(ctx context.Context, ruleId string, qp *query.Params) (*Response, error)

Removes a specific group rule by id from your organization

func (*GroupResource) GetGroup 

func (m *GroupResource) GetGroup(ctx context.Context, groupId string) (*Group, *Response, error)

Fetches a group from your organization.

func (*GroupResource) GetGroupRule 

func (m *GroupResource) GetGroupRule(ctx context.Context, ruleId string, qp *query.Params) (*GroupRule, *Response, error)

Fetches a specific group rule by id from your organization

func (*GroupResource) GetRole 

func (m *GroupResource) GetRole(ctx context.Context, groupId string, roleId string) (*Role, *Response, error)

func (*GroupResource) ListApplicationTargetsForApplicationAdministratorRoleForGroup 

func (m *GroupResource) ListApplicationTargetsForApplicationAdministratorRoleForGroup(ctx context.Context, groupId string, roleId string, qp *query.Params) ([]*CatalogApplication, *Response, error)

Lists all App targets for an `APP_ADMIN` Role assigned to a Group. This methods return list may include full Applications or Instances. The response for an instance will have an `ID` value, while Application will not have an ID.

func (*GroupResource) ListAssignedApplicationsForGroup 

func (m *GroupResource) ListAssignedApplicationsForGroup(ctx context.Context, groupId string, qp *query.Params) ([]App, *Response, error)

Enumerates all applications that are assigned to a group.

func (*GroupResource) ListGroupAssignedRoles 

func (m *GroupResource) ListGroupAssignedRoles(ctx context.Context, groupId string, qp *query.Params) ([]*Role, *Response, error)

func (*GroupResource) ListGroupRules 

func (m *GroupResource) ListGroupRules(ctx context.Context, qp *query.Params) ([]*GroupRule, *Response, error)

Lists all group rules for your organization.

func (*GroupResource) ListGroupTargetsForGroupRole 

func (m *GroupResource) ListGroupTargetsForGroupRole(ctx context.Context, groupId string, roleId string, qp *query.Params) ([]*Group, *Response, error)

func (*GroupResource) ListGroupUsers 

func (m *GroupResource) ListGroupUsers(ctx context.Context, groupId string, qp *query.Params) ([]*User, *Response, error)

Enumerates all users that are a member of a group.

func (*GroupResource) ListGroups 

func (m *GroupResource) ListGroups(ctx context.Context, qp *query.Params) ([]*Group, *Response, error)

Enumerates groups in your organization with pagination. A subset of groups can be returned that match a supported filter expression or query.

func (*GroupResource) RemoveApplicationTargetFromAdministratorRoleGivenToGroup 

func (m *GroupResource) RemoveApplicationTargetFromAdministratorRoleGivenToGroup(ctx context.Context, groupId string, roleId string, appName string, applicationId string) (*Response, error)

Remove App Instance Target to App Administrator Role given to a Group

func (*GroupResource) RemoveApplicationTargetFromApplicationAdministratorRoleGivenToGroup 

func (m *GroupResource) RemoveApplicationTargetFromApplicationAdministratorRoleGivenToGroup(ctx context.Context, groupId string, roleId string, appName string) (*Response, error)

func (*GroupResource) RemoveGroupTargetFromGroupAdministratorRoleGivenToGroup 

func (m *GroupResource) RemoveGroupTargetFromGroupAdministratorRoleGivenToGroup(ctx context.Context, groupId string, roleId string, targetGroupId string) (*Response, error)

func (*GroupResource) RemoveRoleFromGroup 

func (m *GroupResource) RemoveRoleFromGroup(ctx context.Context, groupId string, roleId string) (*Response, error)

Unassigns a Role from a Group

func (*GroupResource) RemoveUserFromGroup 

func (m *GroupResource) RemoveUserFromGroup(ctx context.Context, groupId string, userId string) (*Response, error)

Removes a user from a group with 'OKTA_GROUP' type.

func (*GroupResource) UpdateGroup 

func (m *GroupResource) UpdateGroup(ctx context.Context, groupId string, body Group) (*Group, *Response, error)

Updates the profile for a group with `OKTA_GROUP` type from your organization.

func (*GroupResource) UpdateGroupRule 

func (m *GroupResource) UpdateGroupRule(ctx context.Context, ruleId string, body GroupRule) (*GroupRule, *Response, error)

Updates a group rule. Only `INACTIVE` rules can be updated.

type GroupRule 

type GroupRule struct {
	Actions     *GroupRuleAction     `json:"actions,omitempty"`
	Conditions  *GroupRuleConditions `json:"conditions,omitempty"`
	Created     *time.Time           `json:"created,omitempty"`
	Id          string               `json:"id,omitempty"`
	LastUpdated *time.Time           `json:"lastUpdated,omitempty"`
	Name        string               `json:"name,omitempty"`
	Status      string               `json:"status,omitempty"`
	Type        string               `json:"type,omitempty"`
}

type GroupRuleAction 

type GroupRuleAction struct {
	AssignUserToGroups *GroupRuleGroupAssignment `json:"assignUserToGroups,omitempty"`
}

type GroupRuleConditions 

type GroupRuleConditions struct {
	Expression *GroupRuleExpression      `json:"expression,omitempty"`
	People     *GroupRulePeopleCondition `json:"people,omitempty"`
}

type GroupRuleExpression 

type GroupRuleExpression struct {
	Type  string `json:"type,omitempty"`
	Value string `json:"value,omitempty"`
}

type GroupRuleGroupAssignment 

type GroupRuleGroupAssignment struct {
	GroupIds []string `json:"groupIds,omitempty"`
}

type GroupRuleGroupCondition 

type GroupRuleGroupCondition struct {
	Exclude []string `json:"exclude,omitempty"`
	Include []string `json:"include,omitempty"`
}

type GroupRulePeopleCondition 

type GroupRulePeopleCondition struct {
	Groups *GroupRuleGroupCondition `json:"groups,omitempty"`
	Users  *GroupRuleUserCondition  `json:"users,omitempty"`
}

type GroupRuleResource 

type GroupRuleResource resource

func (*GroupRuleResource) DeleteGroupRule 

func (m *GroupRuleResource) DeleteGroupRule(ctx context.Context, ruleId string, qp *query.Params) (*Response, error)

Removes a specific group rule by id from your organization

func (*GroupRuleResource) UpdateGroupRule 

func (m *GroupRuleResource) UpdateGroupRule(ctx context.Context, ruleId string, body GroupRule) (*GroupRule, *Response, error)

Updates a group rule. Only `INACTIVE` rules can be updated.

type GroupRuleStatus 

type GroupRuleStatus string

type GroupRuleUserCondition 

type GroupRuleUserCondition struct {
	Exclude []string `json:"exclude,omitempty"`
	Include []string `json:"include,omitempty"`
}

type GroupSchema added in v2.6.2 

type GroupSchema struct {
	Schema      string                  `json:"$schema,omitempty"`
	Links       interface{}             `json:"_links,omitempty"`
	Created     string                  `json:"created,omitempty"`
	Definitions *GroupSchemaDefinitions `json:"definitions,omitempty"`
	Description string                  `json:"description,omitempty"`
	Id          string                  `json:"id,omitempty"`
	LastUpdated string                  `json:"lastUpdated,omitempty"`
	Name        string                  `json:"name,omitempty"`
	Properties  *UserSchemaProperties   `json:"properties,omitempty"`
	Title       string                  `json:"title,omitempty"`
	Type        string                  `json:"type,omitempty"`
}

type GroupSchemaAttribute added in v2.6.2 

type GroupSchemaAttribute struct {
	Description       string                           `json:"description,omitempty"`
	Enum              []interface{}                    `json:"enum,omitempty"`
	ExternalName      string                           `json:"externalName,omitempty"`
	ExternalNamespace string                           `json:"externalNamespace,omitempty"`
	Items             *UserSchemaAttributeItems        `json:"items,omitempty"`
	Master            *UserSchemaAttributeMaster       `json:"master,omitempty"`
	MaxLength         int64                            `json:"-"`
	MaxLengthPtr      *int64                           `json:"maxLength,omitempty"`
	MinLength         int64                            `json:"-"`
	MinLengthPtr      *int64                           `json:"minLength,omitempty"`
	Mutability        string                           `json:"mutability,omitempty"`
	OneOf             []*UserSchemaAttributeEnum       `json:"oneOf,omitempty"`
	Permissions       []*UserSchemaAttributePermission `json:"permissions,omitempty"`
	Required          *bool                            `json:"required,omitempty"`
	Scope             string                           `json:"scope,omitempty"`
	Title             string                           `json:"title,omitempty"`
	Type              string                           `json:"type,omitempty"`
	Union             string                           `json:"union,omitempty"`
	Unique            string                           `json:"unique,omitempty"`
}

func (*GroupSchemaAttribute) MarshalJSON added in v2.17.0 

func (a *GroupSchemaAttribute) MarshalJSON() ([]byte, error)

func (*GroupSchemaAttribute) UnmarshalJSON added in v2.17.0 

func (a *GroupSchemaAttribute) UnmarshalJSON(data []byte) error

type GroupSchemaBase added in v2.6.2 

type GroupSchemaBase struct {
	Id         string                           `json:"id,omitempty"`
	Properties map[string]*GroupSchemaAttribute `json:"properties,omitempty"`
	Required   []string                         `json:"required,omitempty"`
	Type       string                           `json:"type,omitempty"`
}

type GroupSchemaBaseProperties added in v2.6.2 

type GroupSchemaBaseProperties struct {
	Description *GroupSchemaAttribute `json:"description,omitempty"`
	Name        *GroupSchemaAttribute `json:"name,omitempty"`
}

type GroupSchemaCustom added in v2.6.2 

type GroupSchemaCustom struct {
	Id         string                           `json:"id,omitempty"`
	Properties map[string]*GroupSchemaAttribute `json:"properties,omitempty"`
	Required   []string                         `json:"required,omitempty"`
	Type       string                           `json:"type,omitempty"`
}

type GroupSchemaDefinitions added in v2.6.2 

type GroupSchemaDefinitions struct {
	Base   *GroupSchemaBase   `json:"base,omitempty"`
	Custom *GroupSchemaCustom `json:"custom,omitempty"`
}

type GroupSchemaResource added in v2.6.2 

type GroupSchemaResource resource

func (*GroupSchemaResource) GetGroupSchema added in v2.6.2 

func (m *GroupSchemaResource) GetGroupSchema(ctx context.Context) (*GroupSchema, *Response, error)

Fetches the group schema

func (*GroupSchemaResource) UpdateGroupSchema added in v2.6.2 

func (m *GroupSchemaResource) UpdateGroupSchema(ctx context.Context, body GroupSchema) (*GroupSchema, *Response, error)

Updates, adds ore removes one or more custom Group Profile properties in the schema

type GroupType 

type GroupType string

type HardwareUserFactor 

type HardwareUserFactor struct {
	Embedded    interface{}                `json:"_embedded,omitempty"`
	Links       interface{}                `json:"_links,omitempty"`
	Created     *time.Time                 `json:"created,omitempty"`
	FactorType  string                     `json:"factorType,omitempty"`
	Id          string                     `json:"id,omitempty"`
	LastUpdated *time.Time                 `json:"lastUpdated,omitempty"`
	Provider    string                     `json:"provider,omitempty"`
	Status      string                     `json:"status,omitempty"`
	Verify      *VerifyFactorRequest       `json:"verify,omitempty"`
	Profile     *HardwareUserFactorProfile `json:"profile,omitempty"`
}

func NewHardwareUserFactor 

func NewHardwareUserFactor() *HardwareUserFactor

func (*HardwareUserFactor) IsUserFactorInstance 

func (a *HardwareUserFactor) IsUserFactorInstance() bool

type HardwareUserFactorProfile 

type HardwareUserFactorProfile struct {
	CredentialId string `json:"credentialId,omitempty"`
}

func NewHardwareUserFactorProfile 

func NewHardwareUserFactorProfile() *HardwareUserFactorProfile

func (*HardwareUserFactorProfile) IsUserFactorInstance 

func (a *HardwareUserFactorProfile) IsUserFactorInstance() bool

type IdentityProvider 

type IdentityProvider struct {
	Links       interface{}             `json:"_links,omitempty"`
	Created     *time.Time              `json:"created,omitempty"`
	Id          string                  `json:"id,omitempty"`
	IssuerMode  string                  `json:"issuerMode,omitempty"`
	LastUpdated *time.Time              `json:"lastUpdated,omitempty"`
	Name        string                  `json:"name,omitempty"`
	Policy      *IdentityProviderPolicy `json:"policy,omitempty"`
	Protocol    *Protocol               `json:"protocol,omitempty"`
	Status      string                  `json:"status,omitempty"`
	Type        string                  `json:"type,omitempty"`
}

type IdentityProviderApplicationUser 

type IdentityProviderApplicationUser struct {
	Embedded    interface{} `json:"_embedded,omitempty"`
	Links       interface{} `json:"_links,omitempty"`
	Created     string      `json:"created,omitempty"`
	ExternalId  string      `json:"externalId,omitempty"`
	Id          string      `json:"id,omitempty"`
	LastUpdated string      `json:"lastUpdated,omitempty"`
	Profile     interface{} `json:"profile,omitempty"`
}

type IdentityProviderCredentials 

type IdentityProviderCredentials struct {
	Client  *IdentityProviderCredentialsClient  `json:"client,omitempty"`
	Signing *IdentityProviderCredentialsSigning `json:"signing,omitempty"`
	Trust   *IdentityProviderCredentialsTrust   `json:"trust,omitempty"`
}

type IdentityProviderCredentialsClient 

type IdentityProviderCredentialsClient struct {
	ClientId     string `json:"client_id,omitempty"`
	ClientSecret string `json:"client_secret,omitempty"`
}

type IdentityProviderCredentialsSigning 

type IdentityProviderCredentialsSigning struct {
	Kid        string `json:"kid,omitempty"`
	PrivateKey string `json:"privateKey,omitempty"`
	TeamId     string `json:"teamId,omitempty"`
}

type IdentityProviderCredentialsTrust 

type IdentityProviderCredentialsTrust struct {
	Audience                   string `json:"audience,omitempty"`
	Issuer                     string `json:"issuer,omitempty"`
	Kid                        string `json:"kid,omitempty"`
	Revocation                 string `json:"revocation,omitempty"`
	RevocationCacheLifetime    int64  `json:"-"`
	RevocationCacheLifetimePtr *int64 `json:"revocationCacheLifetime,omitempty"`
}

func (*IdentityProviderCredentialsTrust) MarshalJSON added in v2.17.0 

func (a *IdentityProviderCredentialsTrust) MarshalJSON() ([]byte, error)

func (*IdentityProviderCredentialsTrust) UnmarshalJSON added in v2.17.0 

func (a *IdentityProviderCredentialsTrust) UnmarshalJSON(data []byte) error

type IdentityProviderPolicy 

type IdentityProviderPolicy struct {
	Embedded        interface{}           `json:"_embedded,omitempty"`
	Links           interface{}           `json:"_links,omitempty"`
	Conditions      *PolicyRuleConditions `json:"conditions,omitempty"`
	Created         *time.Time            `json:"created,omitempty"`
	Description     string                `json:"description,omitempty"`
	Id              string                `json:"id,omitempty"`
	LastUpdated     *time.Time            `json:"lastUpdated,omitempty"`
	Name            string                `json:"name,omitempty"`
	Priority        int64                 `json:"-"`
	PriorityPtr     *int64                `json:"priority,omitempty"`
	Status          string                `json:"status,omitempty"`
	System          *bool                 `json:"system,omitempty"`
	Type            string                `json:"type,omitempty"`
	AccountLink     *PolicyAccountLink    `json:"accountLink,omitempty"`
	MaxClockSkew    int64                 `json:"-"`
	MaxClockSkewPtr *int64                `json:"maxClockSkew,omitempty"`
	Provisioning    *Provisioning         `json:"provisioning,omitempty"`
	Subject         *PolicySubject        `json:"subject,omitempty"`
}

func NewIdentityProviderPolicy added in v2.10.1 

func NewIdentityProviderPolicy() *IdentityProviderPolicy

func (*IdentityProviderPolicy) IsPolicyInstance added in v2.10.1 

func (a *IdentityProviderPolicy) IsPolicyInstance() bool

func (*IdentityProviderPolicy) MarshalJSON added in v2.17.0 

func (a *IdentityProviderPolicy) MarshalJSON() ([]byte, error)

func (*IdentityProviderPolicy) UnmarshalJSON added in v2.17.0 

func (a *IdentityProviderPolicy) UnmarshalJSON(data []byte) error

type IdentityProviderPolicyRuleCondition 

type IdentityProviderPolicyRuleCondition struct {
	IdpIds   []string `json:"idpIds,omitempty"`
	Provider string   `json:"provider,omitempty"`
}

func NewIdentityProviderPolicyRuleCondition added in v2.10.1 

func NewIdentityProviderPolicyRuleCondition() *IdentityProviderPolicyRuleCondition

func (*IdentityProviderPolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *IdentityProviderPolicyRuleCondition) IsPolicyInstance() bool

type IdentityProviderResource 

type IdentityProviderResource resource

func (*IdentityProviderResource) ActivateIdentityProvider 

func (m *IdentityProviderResource) ActivateIdentityProvider(ctx context.Context, idpId string) (*IdentityProvider, *Response, error)

Activates an inactive IdP.

func (*IdentityProviderResource) CloneIdentityProviderKey 

func (m *IdentityProviderResource) CloneIdentityProviderKey(ctx context.Context, idpId string, keyId string, qp *query.Params) (*JsonWebKey, *Response, error)

Clones a X.509 certificate for an IdP signing key credential from a source IdP to target IdP

func (*IdentityProviderResource) CreateIdentityProvider 

func (m *IdentityProviderResource) CreateIdentityProvider(ctx context.Context, body IdentityProvider) (*IdentityProvider, *Response, error)

Adds a new IdP to your organization.

func (*IdentityProviderResource) CreateIdentityProviderKey 

func (m *IdentityProviderResource) CreateIdentityProviderKey(ctx context.Context, body JsonWebKey) (*JsonWebKey, *Response, error)

Adds a new X.509 certificate credential to the IdP key store.

func (*IdentityProviderResource) DeactivateIdentityProvider 

func (m *IdentityProviderResource) DeactivateIdentityProvider(ctx context.Context, idpId string) (*IdentityProvider, *Response, error)

Deactivates an active IdP.

func (*IdentityProviderResource) DeleteIdentityProvider 

func (m *IdentityProviderResource) DeleteIdentityProvider(ctx context.Context, idpId string) (*Response, error)

Removes an IdP from your organization.

func (*IdentityProviderResource) DeleteIdentityProviderKey 

func (m *IdentityProviderResource) DeleteIdentityProviderKey(ctx context.Context, keyId string) (*Response, error)

Deletes a specific IdP Key Credential by `kid` if it is not currently being used by an Active or Inactive IdP.

func (*IdentityProviderResource) GenerateCsrForIdentityProvider 

func (m *IdentityProviderResource) GenerateCsrForIdentityProvider(ctx context.Context, idpId string, body CsrMetadata) (*Csr, *Response, error)

Generates a new key pair and returns a Certificate Signing Request for it.

func (*IdentityProviderResource) GenerateIdentityProviderSigningKey 

func (m *IdentityProviderResource) GenerateIdentityProviderSigningKey(ctx context.Context, idpId string, qp *query.Params) (*JsonWebKey, *Response, error)

Generates a new X.509 certificate for an IdP signing key credential to be used for signing assertions sent to the IdP

func (*IdentityProviderResource) GetCsrForIdentityProvider 

func (m *IdentityProviderResource) GetCsrForIdentityProvider(ctx context.Context, idpId string, csrId string) (*Csr, *Response, error)

Gets a specific Certificate Signing Request model by id

func (*IdentityProviderResource) GetIdentityProvider 

func (m *IdentityProviderResource) GetIdentityProvider(ctx context.Context, idpId string) (*IdentityProvider, *Response, error)

Fetches an IdP by `id`.

func (*IdentityProviderResource) GetIdentityProviderApplicationUser 

func (m *IdentityProviderResource) GetIdentityProviderApplicationUser(ctx context.Context, idpId string, userId string) (*IdentityProviderApplicationUser, *Response, error)

Fetches a linked IdP user by ID

func (*IdentityProviderResource) GetIdentityProviderKey 

func (m *IdentityProviderResource) GetIdentityProviderKey(ctx context.Context, keyId string) (*JsonWebKey, *Response, error)

Gets a specific IdP Key Credential by `kid`

func (*IdentityProviderResource) GetIdentityProviderSigningKey 

func (m *IdentityProviderResource) GetIdentityProviderSigningKey(ctx context.Context, idpId string, keyId string) (*JsonWebKey, *Response, error)

Gets a specific IdP Key Credential by `kid`

func (*IdentityProviderResource) LinkUserToIdentityProvider 

func (m *IdentityProviderResource) LinkUserToIdentityProvider(ctx context.Context, idpId string, userId string, body UserIdentityProviderLinkRequest) (*IdentityProviderApplicationUser, *Response, error)

Links an Okta user to an existing Social Identity Provider. This does not support the SAML2 Identity Provider Type

func (*IdentityProviderResource) ListCsrsForIdentityProvider 

func (m *IdentityProviderResource) ListCsrsForIdentityProvider(ctx context.Context, idpId string) ([]*Csr, *Response, error)

Enumerates Certificate Signing Requests for an IdP

func (*IdentityProviderResource) ListIdentityProviderApplicationUsers 

func (m *IdentityProviderResource) ListIdentityProviderApplicationUsers(ctx context.Context, idpId string) ([]*IdentityProviderApplicationUser, *Response, error)

Find all the users linked to an identity provider

func (*IdentityProviderResource) ListIdentityProviderKeys 

func (m *IdentityProviderResource) ListIdentityProviderKeys(ctx context.Context, qp *query.Params) ([]*JsonWebKey, *Response, error)

Enumerates IdP key credentials.

func (*IdentityProviderResource) ListIdentityProviderSigningKeys 

func (m *IdentityProviderResource) ListIdentityProviderSigningKeys(ctx context.Context, idpId string) ([]*JsonWebKey, *Response, error)

Enumerates signing key credentials for an IdP

func (*IdentityProviderResource) ListIdentityProviders 

func (m *IdentityProviderResource) ListIdentityProviders(ctx context.Context, qp *query.Params) ([]*IdentityProvider, *Response, error)

Enumerates IdPs in your organization with pagination. A subset of IdPs can be returned that match a supported filter expression or query.

func (*IdentityProviderResource) ListSocialAuthTokens 

func (m *IdentityProviderResource) ListSocialAuthTokens(ctx context.Context, idpId string, userId string) ([]*SocialAuthToken, *Response, error)

Fetches the tokens minted by the Social Authentication Provider when the user authenticates with Okta via Social Auth.

func (*IdentityProviderResource) PublishBinaryCerCertForIdentityProvider 

func (m *IdentityProviderResource) PublishBinaryCerCertForIdentityProvider(ctx context.Context, idpId string, csrId string, body string) (*JsonWebKey, *Response, error)

Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.

func (*IdentityProviderResource) PublishBinaryDerCertForIdentityProvider 

func (m *IdentityProviderResource) PublishBinaryDerCertForIdentityProvider(ctx context.Context, idpId string, csrId string, body string) (*JsonWebKey, *Response, error)

Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.

func (*IdentityProviderResource) PublishBinaryPemCertForIdentityProvider 

func (m *IdentityProviderResource) PublishBinaryPemCertForIdentityProvider(ctx context.Context, idpId string, csrId string, body string) (*JsonWebKey, *Response, error)

Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.

func (*IdentityProviderResource) PublishCerCertForIdentityProvider 

func (m *IdentityProviderResource) PublishCerCertForIdentityProvider(ctx context.Context, idpId string, csrId string, body string) (*JsonWebKey, *Response, error)

Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.

func (*IdentityProviderResource) PublishDerCertForIdentityProvider 

func (m *IdentityProviderResource) PublishDerCertForIdentityProvider(ctx context.Context, idpId string, csrId string, body string) (*JsonWebKey, *Response, error)

Update the Certificate Signing Request with a signed X.509 certificate and add it into the signing key credentials for the IdP.

func (*IdentityProviderResource) RevokeCsrForIdentityProvider 

func (m *IdentityProviderResource) RevokeCsrForIdentityProvider(ctx context.Context, idpId string, csrId string) (*Response, error)

Revoke a Certificate Signing Request and delete the key pair from the IdP

func (*IdentityProviderResource) UnlinkUserFromIdentityProvider 

func (m *IdentityProviderResource) UnlinkUserFromIdentityProvider(ctx context.Context, idpId string, userId string) (*Response, error)

Removes the link between the Okta user and the IdP user.

func (*IdentityProviderResource) UpdateIdentityProvider 

func (m *IdentityProviderResource) UpdateIdentityProvider(ctx context.Context, idpId string, body IdentityProvider) (*IdentityProvider, *Response, error)

Updates the configuration for an IdP.

type IdpPolicyRuleAction added in v2.11.0 

type IdpPolicyRuleAction struct {
	Providers []*IdpPolicyRuleActionProvider `json:"providers,omitempty"`
}

func NewIdpPolicyRuleAction added in v2.11.0 

func NewIdpPolicyRuleAction() *IdpPolicyRuleAction

func (*IdpPolicyRuleAction) IsPolicyInstance added in v2.11.0 

func (a *IdpPolicyRuleAction) IsPolicyInstance() bool

type IdpPolicyRuleActionProvider added in v2.11.0 

type IdpPolicyRuleActionProvider struct {
	Id   string `json:"id,omitempty"`
	Type string `json:"type,omitempty"`
}

func NewIdpPolicyRuleActionProvider added in v2.11.0 

func NewIdpPolicyRuleActionProvider() *IdpPolicyRuleActionProvider

func (*IdpPolicyRuleActionProvider) IsPolicyInstance added in v2.11.0 

func (a *IdpPolicyRuleActionProvider) IsPolicyInstance() bool

type IframeEmbedScopeAllowedApps added in v2.12.0 

type IframeEmbedScopeAllowedApps string

type ImageUploadResponse added in v2.9.1 

type ImageUploadResponse struct {
	Url string `json:"url,omitempty"`
}

type InactivityPolicyRuleCondition 

type InactivityPolicyRuleCondition struct {
	Number    int64  `json:"-"`
	NumberPtr *int64 `json:"number,omitempty"`
	Unit      string `json:"unit,omitempty"`
}

func NewInactivityPolicyRuleCondition added in v2.10.1 

func NewInactivityPolicyRuleCondition() *InactivityPolicyRuleCondition

func (*InactivityPolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *InactivityPolicyRuleCondition) IsPolicyInstance() bool

func (*InactivityPolicyRuleCondition) MarshalJSON added in v2.17.0 

func (a *InactivityPolicyRuleCondition) MarshalJSON() ([]byte, error)

func (*InactivityPolicyRuleCondition) UnmarshalJSON added in v2.17.0 

func (a *InactivityPolicyRuleCondition) UnmarshalJSON(data []byte) error

type InlineHook 

type InlineHook struct {
	Links       interface{}        `json:"_links,omitempty"`
	Channel     *InlineHookChannel `json:"channel,omitempty"`
	Created     *time.Time         `json:"created,omitempty"`
	Id          string             `json:"id,omitempty"`
	LastUpdated *time.Time         `json:"lastUpdated,omitempty"`
	Name        string             `json:"name,omitempty"`
	Status      string             `json:"status,omitempty"`
	Type        string             `json:"type,omitempty"`
	Version     string             `json:"version,omitempty"`
}

type InlineHookChannel 

type InlineHookChannel struct {
	Config  *InlineHookChannelConfig `json:"config,omitempty"`
	Type    string                   `json:"type,omitempty"`
	Version string                   `json:"version,omitempty"`
}

type InlineHookChannelConfig 

type InlineHookChannelConfig struct {
	AuthScheme *InlineHookChannelConfigAuthScheme `json:"authScheme,omitempty"`
	Headers    []*InlineHookChannelConfigHeaders  `json:"headers,omitempty"`
	Method     string                             `json:"method,omitempty"`
	Uri        string                             `json:"uri,omitempty"`
}

type InlineHookChannelConfigAuthScheme 

type InlineHookChannelConfigAuthScheme struct {
	Key   string `json:"key,omitempty"`
	Type  string `json:"type,omitempty"`
	Value string `json:"value,omitempty"`
}

type InlineHookChannelConfigHeaders 

type InlineHookChannelConfigHeaders struct {
	Key   string `json:"key,omitempty"`
	Value string `json:"value,omitempty"`
}

type InlineHookPayload 

type InlineHookPayload struct{}

type InlineHookResource 

type InlineHookResource resource

func (*InlineHookResource) ActivateInlineHook 

func (m *InlineHookResource) ActivateInlineHook(ctx context.Context, inlineHookId string) (*InlineHook, *Response, error)

Activates the Inline Hook matching the provided id

func (*InlineHookResource) CreateInlineHook 

func (m *InlineHookResource) CreateInlineHook(ctx context.Context, body InlineHook) (*InlineHook, *Response, error)

func (*InlineHookResource) DeactivateInlineHook 

func (m *InlineHookResource) DeactivateInlineHook(ctx context.Context, inlineHookId string) (*InlineHook, *Response, error)

Deactivates the Inline Hook matching the provided id

func (*InlineHookResource) DeleteInlineHook 

func (m *InlineHookResource) DeleteInlineHook(ctx context.Context, inlineHookId string) (*Response, error)

Deletes the Inline Hook matching the provided id. Once deleted, the Inline Hook is unrecoverable. As a safety precaution, only Inline Hooks with a status of INACTIVE are eligible for deletion.

func (*InlineHookResource) ExecuteInlineHook 

func (m *InlineHookResource) ExecuteInlineHook(ctx context.Context, inlineHookId string, body InlineHookPayload) (*InlineHookResponse, *Response, error)

Executes the Inline Hook matching the provided inlineHookId using the request body as the input. This will send the provided data through the Channel and return a response if it matches the correct data contract. This execution endpoint should only be used for testing purposes.

func (*InlineHookResource) GetInlineHook 

func (m *InlineHookResource) GetInlineHook(ctx context.Context, inlineHookId string) (*InlineHook, *Response, error)

Gets an inline hook by ID

func (*InlineHookResource) ListInlineHooks 

func (m *InlineHookResource) ListInlineHooks(ctx context.Context, qp *query.Params) ([]*InlineHook, *Response, error)

func (*InlineHookResource) UpdateInlineHook 

func (m *InlineHookResource) UpdateInlineHook(ctx context.Context, inlineHookId string, body InlineHook) (*InlineHook, *Response, error)

Updates an inline hook by ID

type InlineHookResponse 

type InlineHookResponse struct {
	Commands []*InlineHookResponseCommands `json:"commands,omitempty"`
}

type InlineHookResponseCommandValue 

type InlineHookResponseCommandValue struct {
	Op    string `json:"op,omitempty"`
	Path  string `json:"path,omitempty"`
	Value string `json:"value,omitempty"`
}

type InlineHookResponseCommands 

type InlineHookResponseCommands struct {
	Type  string                            `json:"type,omitempty"`
	Value []*InlineHookResponseCommandValue `json:"value,omitempty"`
}

type InlineHookStatus added in v2.1.0 

type InlineHookStatus string

type InlineHookType added in v2.1.0 

type InlineHookType string

type InterceptingRoundTripper added in v2.18.0 

type InterceptingRoundTripper struct {
	Transport   http.RoundTripper
	Interceptor func(*http.Request) error
	Blocking    bool
}

func NewInterceptingRoundTripper added in v2.18.0 

func NewInterceptingRoundTripper(interceptor func(*http.Request) error, transport http.RoundTripper, blocking bool) *InterceptingRoundTripper

func (*InterceptingRoundTripper) RoundTrip added in v2.18.0 

func (c *InterceptingRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

type IonField 

type IonField struct {
	Form     *IonForm    `json:"form,omitempty"`
	Label    string      `json:"label,omitempty"`
	Mutable  *bool       `json:"mutable,omitempty"`
	Name     string      `json:"name,omitempty"`
	Required *bool       `json:"required,omitempty"`
	Secret   *bool       `json:"secret,omitempty"`
	Type     string      `json:"type,omitempty"`
	Value    interface{} `json:"value,omitempty"`
	Visible  *bool       `json:"visible,omitempty"`
}

type IonForm 

type IonForm struct {
	Accepts    string      `json:"accepts,omitempty"`
	Href       string      `json:"href,omitempty"`
	Method     string      `json:"method,omitempty"`
	Name       string      `json:"name,omitempty"`
	Produces   string      `json:"produces,omitempty"`
	Refresh    int64       `json:"-"`
	RefreshPtr *int64      `json:"refresh,omitempty"`
	Rel        []string    `json:"rel,omitempty"`
	RelatesTo  []string    `json:"relatesTo,omitempty"`
	Value      []*IonField `json:"value,omitempty"`
}

func (*IonForm) MarshalJSON added in v2.17.0 

func (a *IonForm) MarshalJSON() ([]byte, error)

func (*IonForm) UnmarshalJSON added in v2.17.0 

func (a *IonForm) UnmarshalJSON(data []byte) error

type JWTAuth added in v2.17.0 

type JWTAuth struct {
	// contains filtered or unexported fields
}

func NewJWTAuth added in v2.17.0 

func NewJWTAuth(config JWTAuthConfig) *JWTAuth

func (*JWTAuth) Authorize added in v2.17.0 

func (a *JWTAuth) Authorize() error

type JWTAuthConfig added in v2.17.0 

type JWTAuthConfig struct {
	TokenCache      *goCache.Cache
	HttpClient      *http.Client
	OrgURL          string
	Scopes          []string
	ClientAssertion string
	MaxRetries      int32
	MaxBackoff      int64
	Req             *http.Request
}

type JsonWebKey 

type JsonWebKey struct {
	Links       interface{} `json:"_links,omitempty"`
	Alg         string      `json:"alg,omitempty"`
	Created     *time.Time  `json:"created,omitempty"`
	E           string      `json:"e,omitempty"`
	ExpiresAt   *time.Time  `json:"expiresAt,omitempty"`
	KeyOps      []string    `json:"key_ops,omitempty"`
	Kid         string      `json:"kid,omitempty"`
	Kty         string      `json:"kty,omitempty"`
	LastUpdated *time.Time  `json:"lastUpdated,omitempty"`
	N           string      `json:"n,omitempty"`
	Status      string      `json:"status,omitempty"`
	Use         string      `json:"use,omitempty"`
	X5c         []string    `json:"x5c,omitempty"`
	X5t         string      `json:"x5t,omitempty"`
	X5tS256     string      `json:"x5t#S256,omitempty"`
	X5u         string      `json:"x5u,omitempty"`
}

type JwkUse 

type JwkUse struct {
	Use string `json:"use,omitempty"`
}

type KnowledgeConstraint added in v2.9.1 

type KnowledgeConstraint struct {
	Methods          []string `json:"methods,omitempty"`
	ReauthenticateIn string   `json:"reauthenticateIn,omitempty"`
	Types            []string `json:"types,omitempty"`
}

func NewKnowledgeConstraint added in v2.10.1 

func NewKnowledgeConstraint() *KnowledgeConstraint

func (*KnowledgeConstraint) IsPolicyInstance added in v2.10.1 

func (a *KnowledgeConstraint) IsPolicyInstance() bool

type LifecycleCreateSettingObject added in v2.10.0 

type LifecycleCreateSettingObject struct {
	Status string `json:"status,omitempty"`
}

func NewLifecycleCreateSettingObject added in v2.10.0 

func NewLifecycleCreateSettingObject() *LifecycleCreateSettingObject

func (*LifecycleCreateSettingObject) IsApplicationInstance added in v2.10.0 

func (a *LifecycleCreateSettingObject) IsApplicationInstance() bool

type LifecycleDeactivateSettingObject added in v2.10.0 

type LifecycleDeactivateSettingObject struct {
	Status string `json:"status,omitempty"`
}

func NewLifecycleDeactivateSettingObject added in v2.10.0 

func NewLifecycleDeactivateSettingObject() *LifecycleDeactivateSettingObject

func (*LifecycleDeactivateSettingObject) IsApplicationInstance added in v2.10.0 

func (a *LifecycleDeactivateSettingObject) IsApplicationInstance() bool

type LifecycleExpirationPolicyRuleCondition 

type LifecycleExpirationPolicyRuleCondition struct {
	LifecycleStatus string `json:"lifecycleStatus,omitempty"`
	Number          int64  `json:"-"`
	NumberPtr       *int64 `json:"number,omitempty"`
	Unit            string `json:"unit,omitempty"`
}

func NewLifecycleExpirationPolicyRuleCondition added in v2.10.1 

func NewLifecycleExpirationPolicyRuleCondition() *LifecycleExpirationPolicyRuleCondition

func (*LifecycleExpirationPolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *LifecycleExpirationPolicyRuleCondition) IsPolicyInstance() bool

func (*LifecycleExpirationPolicyRuleCondition) MarshalJSON added in v2.17.0 

func (a *LifecycleExpirationPolicyRuleCondition) MarshalJSON() ([]byte, error)

func (*LifecycleExpirationPolicyRuleCondition) UnmarshalJSON added in v2.17.0 

func (a *LifecycleExpirationPolicyRuleCondition) UnmarshalJSON(data []byte) error

type LinkedObject 

type LinkedObject struct {
	Links      interface{}          `json:"_links,omitempty"`
	Associated *LinkedObjectDetails `json:"associated,omitempty"`
	Primary    *LinkedObjectDetails `json:"primary,omitempty"`
}

type LinkedObjectDetails 

type LinkedObjectDetails struct {
	Description string `json:"description,omitempty"`
	Name        string `json:"name,omitempty"`
	Title       string `json:"title,omitempty"`
	Type        string `json:"type,omitempty"`
}

type LinkedObjectDetailsType 

type LinkedObjectDetailsType string

type LinkedObjectResource 

type LinkedObjectResource resource

func (*LinkedObjectResource) AddLinkedObjectDefinition 

func (m *LinkedObjectResource) AddLinkedObjectDefinition(ctx context.Context, body LinkedObject) (*LinkedObject, *Response, error)

func (*LinkedObjectResource) DeleteLinkedObjectDefinition 

func (m *LinkedObjectResource) DeleteLinkedObjectDefinition(ctx context.Context, linkedObjectName string) (*Response, error)

func (*LinkedObjectResource) GetLinkedObjectDefinition 

func (m *LinkedObjectResource) GetLinkedObjectDefinition(ctx context.Context, linkedObjectName string) (*LinkedObject, *Response, error)

func (*LinkedObjectResource) ListLinkedObjectDefinitions 

func (m *LinkedObjectResource) ListLinkedObjectDefinitions(ctx context.Context) ([]*LinkedObject, *Response, error)

type LogActor 

type LogActor struct {
	AlternateId string      `json:"alternateId,omitempty"`
	Detail      interface{} `json:"detail,omitempty"`
	DisplayName string      `json:"displayName,omitempty"`
	Id          string      `json:"id,omitempty"`
	Type        string      `json:"type,omitempty"`
}

type LogAuthenticationContext 

type LogAuthenticationContext struct {
	AuthenticationProvider string     `json:"authenticationProvider,omitempty"`
	AuthenticationStep     int64      `json:"-"`
	AuthenticationStepPtr  *int64     `json:"authenticationStep,omitempty"`
	CredentialProvider     string     `json:"credentialProvider,omitempty"`
	CredentialType         string     `json:"credentialType,omitempty"`
	ExternalSessionId      string     `json:"externalSessionId,omitempty"`
	Interface              string     `json:"interface,omitempty"`
	Issuer                 *LogIssuer `json:"issuer,omitempty"`
}

func (*LogAuthenticationContext) MarshalJSON added in v2.17.0 

func (a *LogAuthenticationContext) MarshalJSON() ([]byte, error)

func (*LogAuthenticationContext) UnmarshalJSON added in v2.17.0 

func (a *LogAuthenticationContext) UnmarshalJSON(data []byte) error

type LogAuthenticationProvider 

type LogAuthenticationProvider string

type LogClient 

type LogClient struct {
	Device              string                  `json:"device,omitempty"`
	GeographicalContext *LogGeographicalContext `json:"geographicalContext,omitempty"`
	Id                  string                  `json:"id,omitempty"`
	IpAddress           string                  `json:"ipAddress,omitempty"`
	UserAgent           *LogUserAgent           `json:"userAgent,omitempty"`
	Zone                string                  `json:"zone,omitempty"`
}

type LogCredentialProvider 

type LogCredentialProvider string

type LogCredentialType 

type LogCredentialType string

type LogDebugContext 

type LogDebugContext struct {
	DebugData interface{} `json:"debugData,omitempty"`
}

type LogEvent 

type LogEvent struct {
	Actor                 *LogActor                 `json:"actor,omitempty"`
	AuthenticationContext *LogAuthenticationContext `json:"authenticationContext,omitempty"`
	Client                *LogClient                `json:"client,omitempty"`
	DebugContext          *LogDebugContext          `json:"debugContext,omitempty"`
	DisplayMessage        string                    `json:"displayMessage,omitempty"`
	EventType             string                    `json:"eventType,omitempty"`
	LegacyEventType       string                    `json:"legacyEventType,omitempty"`
	Outcome               *LogOutcome               `json:"outcome,omitempty"`
	Published             *time.Time                `json:"published,omitempty"`
	Request               *LogRequest               `json:"request,omitempty"`
	SecurityContext       *LogSecurityContext       `json:"securityContext,omitempty"`
	Severity              string                    `json:"severity,omitempty"`
	Target                []*LogTarget              `json:"target,omitempty"`
	Transaction           *LogTransaction           `json:"transaction,omitempty"`
	Uuid                  string                    `json:"uuid,omitempty"`
	Version               string                    `json:"version,omitempty"`
}

type LogEventResource 

type LogEventResource resource

func (*LogEventResource) GetLogs 

func (m *LogEventResource) GetLogs(ctx context.Context, qp *query.Params) ([]*LogEvent, *Response, error)

The Okta System Log API provides read access to your organization’s system log. This API provides more functionality than the Events API

type LogGeographicalContext 

type LogGeographicalContext struct {
	City        string          `json:"city,omitempty"`
	Country     string          `json:"country,omitempty"`
	Geolocation *LogGeolocation `json:"geolocation,omitempty"`
	PostalCode  string          `json:"postalCode,omitempty"`
	State       string          `json:"state,omitempty"`
}

type LogGeolocation 

type LogGeolocation struct {
	Lat float64 `json:"lat,omitempty"`
	Lon float64 `json:"lon,omitempty"`
}

type LogIpAddress 

type LogIpAddress struct {
	GeographicalContext *LogGeographicalContext `json:"geographicalContext,omitempty"`
	Ip                  string                  `json:"ip,omitempty"`
	Source              string                  `json:"source,omitempty"`
	Version             string                  `json:"version,omitempty"`
}

type LogIssuer 

type LogIssuer struct {
	Id   string `json:"id,omitempty"`
	Type string `json:"type,omitempty"`
}

type LogOutcome 

type LogOutcome struct {
	Reason string `json:"reason,omitempty"`
	Result string `json:"result,omitempty"`
}

type LogRequest 

type LogRequest struct {
	IpChain []*LogIpAddress `json:"ipChain,omitempty"`
}

type LogSecurityContext 

type LogSecurityContext struct {
	AsNumber    int64  `json:"-"`
	AsNumberPtr *int64 `json:"asNumber,omitempty"`
	AsOrg       string `json:"asOrg,omitempty"`
	Domain      string `json:"domain,omitempty"`
	IsProxy     *bool  `json:"isProxy,omitempty"`
	Isp         string `json:"isp,omitempty"`
}

func (*LogSecurityContext) MarshalJSON added in v2.17.0 

func (a *LogSecurityContext) MarshalJSON() ([]byte, error)

func (*LogSecurityContext) UnmarshalJSON added in v2.17.0 

func (a *LogSecurityContext) UnmarshalJSON(data []byte) error

type LogSeverity 

type LogSeverity string

type LogTarget 

type LogTarget struct {
	AlternateId string      `json:"alternateId,omitempty"`
	DetailEntry interface{} `json:"detailEntry,omitempty"`
	DisplayName string      `json:"displayName,omitempty"`
	Id          string      `json:"id,omitempty"`
	Type        string      `json:"type,omitempty"`
}

type LogTransaction 

type LogTransaction struct {
	Detail interface{} `json:"detail,omitempty"`
	Id     string      `json:"id,omitempty"`
	Type   string      `json:"type,omitempty"`
}

type LogUserAgent 

type LogUserAgent struct {
	Browser      string `json:"browser,omitempty"`
	Os           string `json:"os,omitempty"`
	RawUserAgent string `json:"rawUserAgent,omitempty"`
}

type MDMEnrollmentPolicyRuleCondition 

type MDMEnrollmentPolicyRuleCondition struct {
	BlockNonSafeAndroid *bool  `json:"blockNonSafeAndroid,omitempty"`
	Enrollment          string `json:"enrollment,omitempty"`
}

func NewMDMEnrollmentPolicyRuleCondition added in v2.10.1 

func NewMDMEnrollmentPolicyRuleCondition() *MDMEnrollmentPolicyRuleCondition

func (*MDMEnrollmentPolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *MDMEnrollmentPolicyRuleCondition) IsPolicyInstance() bool

type MultifactorEnrollmentPolicy added in v2.17.0 

type MultifactorEnrollmentPolicy struct {
	Embedded    interface{}           `json:"_embedded,omitempty"`
	Links       interface{}           `json:"_links,omitempty"`
	Conditions  *PolicyRuleConditions `json:"conditions,omitempty"`
	Created     *time.Time            `json:"created,omitempty"`
	Description string                `json:"description,omitempty"`
	Id          string                `json:"id,omitempty"`
	LastUpdated *time.Time            `json:"lastUpdated,omitempty"`
	Name        string                `json:"name,omitempty"`
	Priority    int64                 `json:"-"`
	PriorityPtr *int64                `json:"priority,omitempty"`
	Status      string                `json:"status,omitempty"`
	System      *bool                 `json:"system,omitempty"`
	Type        string                `json:"type,omitempty"`
}

func NewMultifactorEnrollmentPolicy added in v2.17.0 

func NewMultifactorEnrollmentPolicy() *MultifactorEnrollmentPolicy

func (*MultifactorEnrollmentPolicy) IsPolicyInstance added in v2.17.0 

func (a *MultifactorEnrollmentPolicy) IsPolicyInstance() bool

func (*MultifactorEnrollmentPolicy) MarshalJSON added in v2.17.0 

func (a *MultifactorEnrollmentPolicy) MarshalJSON() ([]byte, error)

func (*MultifactorEnrollmentPolicy) UnmarshalJSON added in v2.17.0 

func (a *MultifactorEnrollmentPolicy) UnmarshalJSON(data []byte) error

type MultifactorEnrollmentPolicyAuthenticatorSettings added in v2.17.0 

type MultifactorEnrollmentPolicyAuthenticatorSettings struct {
	Constraints string `json:"constraints,omitempty"`
	Enroll      string `json:"enroll,omitempty"`
	Key         string `json:"key,omitempty"`
}

func NewMultifactorEnrollmentPolicyAuthenticatorSettings added in v2.17.0 

func NewMultifactorEnrollmentPolicyAuthenticatorSettings() *MultifactorEnrollmentPolicyAuthenticatorSettings

func (*MultifactorEnrollmentPolicyAuthenticatorSettings) IsPolicyInstance added in v2.17.0 

func (a *MultifactorEnrollmentPolicyAuthenticatorSettings) IsPolicyInstance() bool

type MultifactorEnrollmentPolicyAuthenticatorStatus added in v2.17.0 

type MultifactorEnrollmentPolicyAuthenticatorStatus string

type MultifactorEnrollmentPolicyAuthenticatorType added in v2.17.0 

type MultifactorEnrollmentPolicyAuthenticatorType string

type MultifactorEnrollmentPolicySettings added in v2.17.0 

type MultifactorEnrollmentPolicySettings struct {
	Authenticators []*MultifactorEnrollmentPolicyAuthenticatorSettings `json:"authenticators,omitempty"`
	Type           string                                              `json:"type,omitempty"`
}

func NewMultifactorEnrollmentPolicySettings added in v2.17.0 

func NewMultifactorEnrollmentPolicySettings() *MultifactorEnrollmentPolicySettings

func (*MultifactorEnrollmentPolicySettings) IsPolicyInstance added in v2.17.0 

func (a *MultifactorEnrollmentPolicySettings) IsPolicyInstance() bool

type MultifactorEnrollmentPolicySettingsType added in v2.17.0 

type MultifactorEnrollmentPolicySettingsType string

type NetworkZone added in v2.5.2 

type NetworkZone struct {
	Links       interface{}            `json:"_links,omitempty"`
	Asns        []string               `json:"asns,omitempty"`
	Created     *time.Time             `json:"created,omitempty"`
	Gateways    []*NetworkZoneAddress  `json:"gateways,omitempty"`
	Id          string                 `json:"id,omitempty"`
	LastUpdated *time.Time             `json:"lastUpdated,omitempty"`
	Locations   []*NetworkZoneLocation `json:"locations,omitempty"`
	Name        string                 `json:"name,omitempty"`
	Proxies     []*NetworkZoneAddress  `json:"proxies,omitempty"`
	ProxyType   string                 `json:"proxyType,omitempty"`
	Status      string                 `json:"status,omitempty"`
	System      *bool                  `json:"system,omitempty"`
	Type        string                 `json:"type,omitempty"`
	Usage       string                 `json:"usage,omitempty"`
}

type NetworkZoneAddress added in v2.5.2 

type NetworkZoneAddress struct {
	Type  string `json:"type,omitempty"`
	Value string `json:"value,omitempty"`
}

type NetworkZoneAddressType added in v2.5.2 

type NetworkZoneAddressType string

type NetworkZoneLocation added in v2.5.2 

type NetworkZoneLocation struct {
	Country string `json:"country,omitempty"`
	Region  string `json:"region,omitempty"`
}

type NetworkZoneResource added in v2.5.2 

type NetworkZoneResource resource

func (*NetworkZoneResource) ActivateNetworkZone added in v2.5.2 

func (m *NetworkZoneResource) ActivateNetworkZone(ctx context.Context, zoneId string) (*NetworkZone, *Response, error)

Activate Network Zone

func (*NetworkZoneResource) CreateNetworkZone added in v2.5.2 

func (m *NetworkZoneResource) CreateNetworkZone(ctx context.Context, body NetworkZone) (*NetworkZone, *Response, error)

Adds a new network zone to your Okta organization.

func (*NetworkZoneResource) DeactivateNetworkZone added in v2.5.2 

func (m *NetworkZoneResource) DeactivateNetworkZone(ctx context.Context, zoneId string) (*NetworkZone, *Response, error)

Deactivates a network zone.

func (*NetworkZoneResource) DeleteNetworkZone added in v2.5.2 

func (m *NetworkZoneResource) DeleteNetworkZone(ctx context.Context, zoneId string) (*Response, error)

Removes network zone.

func (*NetworkZoneResource) GetNetworkZone added in v2.5.2 

func (m *NetworkZoneResource) GetNetworkZone(ctx context.Context, zoneId string) (*NetworkZone, *Response, error)

Fetches a network zone from your Okta organization by `id`.

func (*NetworkZoneResource) ListNetworkZones added in v2.5.2 

func (m *NetworkZoneResource) ListNetworkZones(ctx context.Context, qp *query.Params) ([]*NetworkZone, *Response, error)

Enumerates network zones added to your organization with pagination. A subset of zones can be returned that match a supported filter expression or query.

func (*NetworkZoneResource) UpdateNetworkZone added in v2.5.2 

func (m *NetworkZoneResource) UpdateNetworkZone(ctx context.Context, zoneId string, body NetworkZone) (*NetworkZone, *Response, error)

Updates a network zone in your organization.

type NetworkZoneStatus added in v2.5.2 

type NetworkZoneStatus string

type NetworkZoneType added in v2.5.2 

type NetworkZoneType string

type NetworkZoneUsage added in v2.5.2 

type NetworkZoneUsage string

type NotificationType added in v2.10.0 

type NotificationType string

type OAuth2Actor 

type OAuth2Actor struct {
	Id   string `json:"id,omitempty"`
	Type string `json:"type,omitempty"`
}

type OAuth2Claim 

type OAuth2Claim struct {
	Links                interface{}            `json:"_links,omitempty"`
	AlwaysIncludeInToken *bool                  `json:"alwaysIncludeInToken,omitempty"`
	ClaimType            string                 `json:"claimType,omitempty"`
	Conditions           *OAuth2ClaimConditions `json:"conditions,omitempty"`
	GroupFilterType      string                 `json:"group_filter_type,omitempty"`
	Id                   string                 `json:"id,omitempty"`
	Name                 string                 `json:"name,omitempty"`
	Status               string                 `json:"status,omitempty"`
	System               *bool                  `json:"system,omitempty"`
	Value                string                 `json:"value,omitempty"`
	ValueType            string                 `json:"valueType,omitempty"`
}

type OAuth2ClaimConditions 

type OAuth2ClaimConditions struct {
	Scopes []string `json:"scopes,omitempty"`
}

type OAuth2Client 

type OAuth2Client struct {
	Links      interface{} `json:"_links,omitempty"`
	ClientId   string      `json:"client_id,omitempty"`
	ClientName string      `json:"client_name,omitempty"`
	ClientUri  string      `json:"client_uri,omitempty"`
	LogoUri    string      `json:"logo_uri,omitempty"`
}

type OAuth2RefreshToken 

type OAuth2RefreshToken struct {
	Embedded    interface{}  `json:"_embedded,omitempty"`
	Links       interface{}  `json:"_links,omitempty"`
	ClientId    string       `json:"clientId,omitempty"`
	Created     *time.Time   `json:"created,omitempty"`
	CreatedBy   *OAuth2Actor `json:"createdBy,omitempty"`
	ExpiresAt   *time.Time   `json:"expiresAt,omitempty"`
	Id          string       `json:"id,omitempty"`
	Issuer      string       `json:"issuer,omitempty"`
	LastUpdated *time.Time   `json:"lastUpdated,omitempty"`
	Scopes      []string     `json:"scopes,omitempty"`
	Status      string       `json:"status,omitempty"`
	UserId      string       `json:"userId,omitempty"`
}

type OAuth2Scope 

type OAuth2Scope struct {
	Consent         string `json:"consent,omitempty"`
	Default         *bool  `json:"default,omitempty"`
	Description     string `json:"description,omitempty"`
	DisplayName     string `json:"displayName,omitempty"`
	Id              string `json:"id,omitempty"`
	MetadataPublish string `json:"metadataPublish,omitempty"`
	Name            string `json:"name,omitempty"`
	System          *bool  `json:"system,omitempty"`
}

type OAuth2ScopeConsentGrant 

type OAuth2ScopeConsentGrant struct {
	Embedded    interface{}  `json:"_embedded,omitempty"`
	Links       interface{}  `json:"_links,omitempty"`
	ClientId    string       `json:"clientId,omitempty"`
	Created     *time.Time   `json:"created,omitempty"`
	CreatedBy   *OAuth2Actor `json:"createdBy,omitempty"`
	Id          string       `json:"id,omitempty"`
	Issuer      string       `json:"issuer,omitempty"`
	LastUpdated *time.Time   `json:"lastUpdated,omitempty"`
	ScopeId     string       `json:"scopeId,omitempty"`
	Source      string       `json:"source,omitempty"`
	Status      string       `json:"status,omitempty"`
	UserId      string       `json:"userId,omitempty"`
}

type OAuth2ScopeConsentGrantSource 

type OAuth2ScopeConsentGrantSource string

type OAuth2ScopeConsentGrantStatus 

type OAuth2ScopeConsentGrantStatus string

type OAuth2ScopesMediationPolicyRuleCondition 

type OAuth2ScopesMediationPolicyRuleCondition struct {
	Include []string `json:"include,omitempty"`
}

type OAuth2Token 

type OAuth2Token struct {
	Embedded    interface{} `json:"_embedded,omitempty"`
	Links       interface{} `json:"_links,omitempty"`
	ClientId    string      `json:"clientId,omitempty"`
	Created     *time.Time  `json:"created,omitempty"`
	ExpiresAt   *time.Time  `json:"expiresAt,omitempty"`
	Id          string      `json:"id,omitempty"`
	Issuer      string      `json:"issuer,omitempty"`
	LastUpdated *time.Time  `json:"lastUpdated,omitempty"`
	Scopes      []string    `json:"scopes,omitempty"`
	Status      string      `json:"status,omitempty"`
	UserId      string      `json:"userId,omitempty"`
}

type OAuthApplicationCredentials 

type OAuthApplicationCredentials struct {
	Signing          *ApplicationCredentialsSigning          `json:"signing,omitempty"`
	UserNameTemplate *ApplicationCredentialsUsernameTemplate `json:"userNameTemplate,omitempty"`
	OauthClient      *ApplicationCredentialsOAuthClient      `json:"oauthClient,omitempty"`
}

type OAuthAuthorizationPolicy 

type OAuthAuthorizationPolicy struct {
	Embedded    interface{}           `json:"_embedded,omitempty"`
	Links       interface{}           `json:"_links,omitempty"`
	Conditions  *PolicyRuleConditions `json:"conditions,omitempty"`
	Created     *time.Time            `json:"created,omitempty"`
	Description string                `json:"description,omitempty"`
	Id          string                `json:"id,omitempty"`
	LastUpdated *time.Time            `json:"lastUpdated,omitempty"`
	Name        string                `json:"name,omitempty"`
	Priority    int64                 `json:"-"`
	PriorityPtr *int64                `json:"priority,omitempty"`
	Status      string                `json:"status,omitempty"`
	System      *bool                 `json:"system,omitempty"`
	Type        string                `json:"type,omitempty"`
}

func NewOAuthAuthorizationPolicy added in v2.10.1 

func NewOAuthAuthorizationPolicy() *OAuthAuthorizationPolicy

func (*OAuthAuthorizationPolicy) IsPolicyInstance added in v2.10.1 

func (a *OAuthAuthorizationPolicy) IsPolicyInstance() bool

func (*OAuthAuthorizationPolicy) MarshalJSON added in v2.17.0 

func (a *OAuthAuthorizationPolicy) MarshalJSON() ([]byte, error)

func (*OAuthAuthorizationPolicy) UnmarshalJSON added in v2.17.0 

func (a *OAuthAuthorizationPolicy) UnmarshalJSON(data []byte) error

type OAuthEndpointAuthenticationMethod 

type OAuthEndpointAuthenticationMethod string

type OAuthGrantType 

type OAuthGrantType string

type OAuthResponseType 

type OAuthResponseType string

type OktaSignOnPolicy 

type OktaSignOnPolicy struct {
	Embedded    interface{}                 `json:"_embedded,omitempty"`
	Links       interface{}                 `json:"_links,omitempty"`
	Conditions  *OktaSignOnPolicyConditions `json:"conditions,omitempty"`
	Created     *time.Time                  `json:"created,omitempty"`
	Description string                      `json:"description,omitempty"`
	Id          string                      `json:"id,omitempty"`
	LastUpdated *time.Time                  `json:"lastUpdated,omitempty"`
	Name        string                      `json:"name,omitempty"`
	Priority    int64                       `json:"-"`
	PriorityPtr *int64                      `json:"priority,omitempty"`
	Status      string                      `json:"status,omitempty"`
	System      *bool                       `json:"system,omitempty"`
	Type        string                      `json:"type,omitempty"`
}

func NewOktaSignOnPolicy added in v2.10.1 

func NewOktaSignOnPolicy() *OktaSignOnPolicy

func (*OktaSignOnPolicy) IsPolicyInstance added in v2.10.1 

func (a *OktaSignOnPolicy) IsPolicyInstance() bool

func (*OktaSignOnPolicy) MarshalJSON added in v2.17.0 

func (a *OktaSignOnPolicy) MarshalJSON() ([]byte, error)

func (*OktaSignOnPolicy) UnmarshalJSON added in v2.17.0 

func (a *OktaSignOnPolicy) UnmarshalJSON(data []byte) error

type OktaSignOnPolicyConditions 

type OktaSignOnPolicyConditions struct {
	App                   *AppAndInstancePolicyRuleCondition             `json:"app,omitempty"`
	Apps                  *AppInstancePolicyRuleCondition                `json:"apps,omitempty"`
	AuthContext           *PolicyRuleAuthContextCondition                `json:"authContext,omitempty"`
	AuthProvider          *PasswordPolicyAuthenticationProviderCondition `json:"authProvider,omitempty"`
	BeforeScheduledAction *BeforeScheduledActionPolicyRuleCondition      `json:"beforeScheduledAction,omitempty"`
	Clients               *ClientPolicyCondition                         `json:"clients,omitempty"`
	Context               *ContextPolicyRuleCondition                    `json:"context,omitempty"`
	Device                *DevicePolicyRuleCondition                     `json:"device,omitempty"`
	GrantTypes            *GrantTypePolicyRuleCondition                  `json:"grantTypes,omitempty"`
	Groups                *GroupPolicyRuleCondition                      `json:"groups,omitempty"`
	IdentityProvider      *IdentityProviderPolicyRuleCondition           `json:"identityProvider,omitempty"`
	MdmEnrollment         *MDMEnrollmentPolicyRuleCondition              `json:"mdmEnrollment,omitempty"`
	Network               *PolicyNetworkCondition                        `json:"network,omitempty"`
	People                *PolicyPeopleCondition                         `json:"people,omitempty"`
	Platform              *PlatformPolicyRuleCondition                   `json:"platform,omitempty"`
	Risk                  *RiskPolicyRuleCondition                       `json:"risk,omitempty"`
	RiskScore             *RiskScorePolicyRuleCondition                  `json:"riskScore,omitempty"`
	Scopes                *OAuth2ScopesMediationPolicyRuleCondition      `json:"scopes,omitempty"`
	UserIdentifier        *UserIdentifierPolicyRuleCondition             `json:"userIdentifier,omitempty"`
	UserStatus            *UserStatusPolicyRuleCondition                 `json:"userStatus,omitempty"`
	Users                 *UserPolicyRuleCondition                       `json:"users,omitempty"`
}

func NewOktaSignOnPolicyConditions added in v2.10.1 

func NewOktaSignOnPolicyConditions() *OktaSignOnPolicyConditions

func (*OktaSignOnPolicyConditions) IsPolicyInstance added in v2.10.1 

func (a *OktaSignOnPolicyConditions) IsPolicyInstance() bool

type OktaSignOnPolicyRule 

type OktaSignOnPolicyRule struct {
	Actions     *OktaSignOnPolicyRuleActions    `json:"actions,omitempty"`
	Conditions  *OktaSignOnPolicyRuleConditions `json:"conditions,omitempty"`
	Created     *time.Time                      `json:"created,omitempty"`
	Id          string                          `json:"id,omitempty"`
	LastUpdated *time.Time                      `json:"lastUpdated,omitempty"`
	Name        string                          `json:"name,omitempty"`
	Priority    int64                           `json:"-"`
	PriorityPtr *int64                          `json:"priority,omitempty"`
	Status      string                          `json:"status,omitempty"`
	System      *bool                           `json:"system,omitempty"`
	Type        string                          `json:"type,omitempty"`
}

func NewOktaSignOnPolicyRule added in v2.10.1 

func NewOktaSignOnPolicyRule() *OktaSignOnPolicyRule

func (*OktaSignOnPolicyRule) IsPolicyInstance added in v2.10.1 

func (a *OktaSignOnPolicyRule) IsPolicyInstance() bool

func (*OktaSignOnPolicyRule) MarshalJSON added in v2.17.0 

func (a *OktaSignOnPolicyRule) MarshalJSON() ([]byte, error)

func (*OktaSignOnPolicyRule) UnmarshalJSON added in v2.17.0 

func (a *OktaSignOnPolicyRule) UnmarshalJSON(data []byte) error

type OktaSignOnPolicyRuleActions 

type OktaSignOnPolicyRuleActions struct {
	Enroll                   *PolicyRuleActionsEnroll           `json:"enroll,omitempty"`
	Idp                      *IdpPolicyRuleAction               `json:"idp,omitempty"`
	PasswordChange           *PasswordPolicyRuleAction          `json:"passwordChange,omitempty"`
	SelfServicePasswordReset *PasswordPolicyRuleAction          `json:"selfServicePasswordReset,omitempty"`
	SelfServiceUnlock        *PasswordPolicyRuleAction          `json:"selfServiceUnlock,omitempty"`
	Signon                   *OktaSignOnPolicyRuleSignonActions `json:"signon,omitempty"`
}

func NewOktaSignOnPolicyRuleActions added in v2.10.1 

func NewOktaSignOnPolicyRuleActions() *OktaSignOnPolicyRuleActions

func (*OktaSignOnPolicyRuleActions) IsPolicyInstance added in v2.10.1 

func (a *OktaSignOnPolicyRuleActions) IsPolicyInstance() bool

type OktaSignOnPolicyRuleConditions 

type OktaSignOnPolicyRuleConditions struct {
	App                   *AppAndInstancePolicyRuleCondition             `json:"app,omitempty"`
	Apps                  *AppInstancePolicyRuleCondition                `json:"apps,omitempty"`
	AuthContext           *PolicyRuleAuthContextCondition                `json:"authContext,omitempty"`
	AuthProvider          *PasswordPolicyAuthenticationProviderCondition `json:"authProvider,omitempty"`
	BeforeScheduledAction *BeforeScheduledActionPolicyRuleCondition      `json:"beforeScheduledAction,omitempty"`
	Clients               *ClientPolicyCondition                         `json:"clients,omitempty"`
	Context               *ContextPolicyRuleCondition                    `json:"context,omitempty"`
	Device                *DevicePolicyRuleCondition                     `json:"device,omitempty"`
	GrantTypes            *GrantTypePolicyRuleCondition                  `json:"grantTypes,omitempty"`
	Groups                *GroupPolicyRuleCondition                      `json:"groups,omitempty"`
	IdentityProvider      *IdentityProviderPolicyRuleCondition           `json:"identityProvider,omitempty"`
	MdmEnrollment         *MDMEnrollmentPolicyRuleCondition              `json:"mdmEnrollment,omitempty"`
	Network               *PolicyNetworkCondition                        `json:"network,omitempty"`
	People                *PolicyPeopleCondition                         `json:"people,omitempty"`
	Platform              *PlatformPolicyRuleCondition                   `json:"platform,omitempty"`
	Risk                  *RiskPolicyRuleCondition                       `json:"risk,omitempty"`
	RiskScore             *RiskScorePolicyRuleCondition                  `json:"riskScore,omitempty"`
	Scopes                *OAuth2ScopesMediationPolicyRuleCondition      `json:"scopes,omitempty"`
	UserIdentifier        *UserIdentifierPolicyRuleCondition             `json:"userIdentifier,omitempty"`
	UserStatus            *UserStatusPolicyRuleCondition                 `json:"userStatus,omitempty"`
	Users                 *UserPolicyRuleCondition                       `json:"users,omitempty"`
}

func NewOktaSignOnPolicyRuleConditions added in v2.10.1 

func NewOktaSignOnPolicyRuleConditions() *OktaSignOnPolicyRuleConditions

func (*OktaSignOnPolicyRuleConditions) IsPolicyInstance added in v2.10.1 

func (a *OktaSignOnPolicyRuleConditions) IsPolicyInstance() bool

type OktaSignOnPolicyRuleSignonActions 

type OktaSignOnPolicyRuleSignonActions struct {
	Access                  string                                    `json:"access,omitempty"`
	FactorLifetime          int64                                     `json:"-"`
	FactorLifetimePtr       *int64                                    `json:"factorLifetime,omitempty"`
	FactorPromptMode        string                                    `json:"factorPromptMode,omitempty"`
	RememberDeviceByDefault *bool                                     `json:"rememberDeviceByDefault,omitempty"`
	RequireFactor           *bool                                     `json:"requireFactor,omitempty"`
	Session                 *OktaSignOnPolicyRuleSignonSessionActions `json:"session,omitempty"`
}

func NewOktaSignOnPolicyRuleSignonActions added in v2.10.1 

func NewOktaSignOnPolicyRuleSignonActions() *OktaSignOnPolicyRuleSignonActions

func (*OktaSignOnPolicyRuleSignonActions) IsPolicyInstance added in v2.10.1 

func (a *OktaSignOnPolicyRuleSignonActions) IsPolicyInstance() bool

func (*OktaSignOnPolicyRuleSignonActions) MarshalJSON added in v2.17.0 

func (a *OktaSignOnPolicyRuleSignonActions) MarshalJSON() ([]byte, error)

func (*OktaSignOnPolicyRuleSignonActions) UnmarshalJSON added in v2.17.0 

func (a *OktaSignOnPolicyRuleSignonActions) UnmarshalJSON(data []byte) error

type OktaSignOnPolicyRuleSignonSessionActions 

type OktaSignOnPolicyRuleSignonSessionActions struct {
	MaxSessionIdleMinutes        int64  `json:"-"`
	MaxSessionIdleMinutesPtr     *int64 `json:"maxSessionIdleMinutes"`
	MaxSessionLifetimeMinutes    int64  `json:"-"`
	MaxSessionLifetimeMinutesPtr *int64 `json:"maxSessionLifetimeMinutes"`
	UsePersistentCookie          *bool  `json:"usePersistentCookie,omitempty"`
}

func NewOktaSignOnPolicyRuleSignonSessionActions added in v2.10.1 

func NewOktaSignOnPolicyRuleSignonSessionActions() *OktaSignOnPolicyRuleSignonSessionActions

func (*OktaSignOnPolicyRuleSignonSessionActions) IsPolicyInstance added in v2.10.1 

func (a *OktaSignOnPolicyRuleSignonSessionActions) IsPolicyInstance() bool

func (*OktaSignOnPolicyRuleSignonSessionActions) MarshalJSON added in v2.17.0 

func (a *OktaSignOnPolicyRuleSignonSessionActions) MarshalJSON() ([]byte, error)

func (*OktaSignOnPolicyRuleSignonSessionActions) UnmarshalJSON added in v2.17.0 

func (a *OktaSignOnPolicyRuleSignonSessionActions) UnmarshalJSON(data []byte) error

type OpenIdConnectApplication 

type OpenIdConnectApplication struct {
	Embedded      interface{}                       `json:"_embedded,omitempty"`
	Links         interface{}                       `json:"_links,omitempty"`
	Accessibility *ApplicationAccessibility         `json:"accessibility,omitempty"`
	Created       *time.Time                        `json:"created,omitempty"`
	Credentials   *OAuthApplicationCredentials      `json:"credentials,omitempty"`
	Features      []string                          `json:"features,omitempty"`
	Id            string                            `json:"id,omitempty"`
	Label         string                            `json:"label,omitempty"`
	LastUpdated   *time.Time                        `json:"lastUpdated,omitempty"`
	Licensing     *ApplicationLicensing             `json:"licensing,omitempty"`
	Name          string                            `json:"name,omitempty"`
	Profile       interface{}                       `json:"profile,omitempty"`
	Settings      *OpenIdConnectApplicationSettings `json:"settings,omitempty"`
	SignOnMode    string                            `json:"signOnMode,omitempty"`
	Status        string                            `json:"status,omitempty"`
	Visibility    *ApplicationVisibility            `json:"visibility,omitempty"`
}

func NewOpenIdConnectApplication 

func NewOpenIdConnectApplication() *OpenIdConnectApplication

func (*OpenIdConnectApplication) IsApplicationInstance 

func (a *OpenIdConnectApplication) IsApplicationInstance() bool

type OpenIdConnectApplicationConsentMethod 

type OpenIdConnectApplicationConsentMethod string

type OpenIdConnectApplicationIdpInitiatedLogin added in v2.3.0 

type OpenIdConnectApplicationIdpInitiatedLogin struct {
	DefaultScope []string `json:"default_scope"`
	Mode         string   `json:"mode,omitempty"`
}

type OpenIdConnectApplicationIssuerMode 

type OpenIdConnectApplicationIssuerMode string

type OpenIdConnectApplicationSettings 

type OpenIdConnectApplicationSettings struct {
	App                *ApplicationSettingsApplication         `json:"app,omitempty"`
	ImplicitAssignment *bool                                   `json:"implicitAssignment,omitempty"`
	InlineHookId       string                                  `json:"inlineHookId,omitempty"`
	Notes              *ApplicationSettingsNotes               `json:"notes,omitempty"`
	Notifications      *ApplicationSettingsNotifications       `json:"notifications,omitempty"`
	OauthClient        *OpenIdConnectApplicationSettingsClient `json:"oauthClient,omitempty"`
}

type OpenIdConnectApplicationSettingsClient 

type OpenIdConnectApplicationSettingsClient struct {
	ApplicationType        string                                        `json:"application_type,omitempty"`
	ClientUri              string                                        `json:"client_uri,omitempty"`
	ConsentMethod          string                                        `json:"consent_method,omitempty"`
	GrantTypes             []*OAuthGrantType                             `json:"grant_types,omitempty"`
	IdpInitiatedLogin      *OpenIdConnectApplicationIdpInitiatedLogin    `json:"idp_initiated_login,omitempty"`
	InitiateLoginUri       string                                        `json:"initiate_login_uri,omitempty"`
	IssuerMode             string                                        `json:"issuer_mode,omitempty"`
	Jwks                   *OpenIdConnectApplicationSettingsClientKeys   `json:"jwks,omitempty"`
	LogoUri                string                                        `json:"logo_uri,omitempty"`
	PolicyUri              string                                        `json:"policy_uri,omitempty"`
	PostLogoutRedirectUris []string                                      `json:"post_logout_redirect_uris,omitempty"`
	RedirectUris           []string                                      `json:"redirect_uris,omitempty"`
	RefreshToken           *OpenIdConnectApplicationSettingsRefreshToken `json:"refresh_token,omitempty"`
	ResponseTypes          []*OAuthResponseType                          `json:"response_types,omitempty"`
	TosUri                 string                                        `json:"tos_uri,omitempty"`
	WildcardRedirect       string                                        `json:"wildcard_redirect,omitempty"`
}

type OpenIdConnectApplicationSettingsClientKeys added in v2.2.0 

type OpenIdConnectApplicationSettingsClientKeys struct {
	Keys []*JsonWebKey `json:"keys,omitempty"`
}

type OpenIdConnectApplicationSettingsRefreshToken added in v2.2.0 

type OpenIdConnectApplicationSettingsRefreshToken struct {
	Leeway       int64  `json:"-"`
	LeewayPtr    *int64 `json:"leeway"`
	RotationType string `json:"rotation_type,omitempty"`
}

func (*OpenIdConnectApplicationSettingsRefreshToken) MarshalJSON added in v2.17.0 

func (a *OpenIdConnectApplicationSettingsRefreshToken) MarshalJSON() ([]byte, error)

func (*OpenIdConnectApplicationSettingsRefreshToken) UnmarshalJSON added in v2.17.0 

func (a *OpenIdConnectApplicationSettingsRefreshToken) UnmarshalJSON(data []byte) error

type OpenIdConnectApplicationType 

type OpenIdConnectApplicationType string

type OpenIdConnectRefreshTokenRotationType added in v2.2.0 

type OpenIdConnectRefreshTokenRotationType string

type Org2OrgApplication added in v2.10.0 

type Org2OrgApplication struct {
	Settings      *Org2OrgApplicationSettings `json:"settings,omitempty"`
	Embedded      interface{}                 `json:"_embedded,omitempty"`
	Links         interface{}                 `json:"_links,omitempty"`
	Accessibility *ApplicationAccessibility   `json:"accessibility,omitempty"`
	Created       *time.Time                  `json:"created,omitempty"`
	Credentials   *ApplicationCredentials     `json:"credentials,omitempty"`
	Features      []string                    `json:"features,omitempty"`
	Id            string                      `json:"id,omitempty"`
	Label         string                      `json:"label,omitempty"`
	LastUpdated   *time.Time                  `json:"lastUpdated,omitempty"`
	Licensing     *ApplicationLicensing       `json:"licensing,omitempty"`
	Name          string                      `json:"name,omitempty"`
	Profile       interface{}                 `json:"profile,omitempty"`
	SignOnMode    string                      `json:"signOnMode,omitempty"`
	Status        string                      `json:"status,omitempty"`
	Visibility    *ApplicationVisibility      `json:"visibility,omitempty"`
}

func NewOrg2OrgApplication added in v2.10.0 

func NewOrg2OrgApplication() *Org2OrgApplication

func (*Org2OrgApplication) IsApplicationInstance added in v2.10.0 

func (a *Org2OrgApplication) IsApplicationInstance() bool

type Org2OrgApplicationSettings added in v2.10.0 

type Org2OrgApplicationSettings struct {
	SignOn             *SamlApplicationSettingsSignOn    `json:"signOn,omitempty"`
	App                *Org2OrgApplicationSettingsApp    `json:"app,omitempty"`
	ImplicitAssignment *bool                             `json:"implicitAssignment,omitempty"`
	InlineHookId       string                            `json:"inlineHookId,omitempty"`
	Notes              *ApplicationSettingsNotes         `json:"notes,omitempty"`
	Notifications      *ApplicationSettingsNotifications `json:"notifications,omitempty"`
}

func NewOrg2OrgApplicationSettings added in v2.10.0 

func NewOrg2OrgApplicationSettings() *Org2OrgApplicationSettings

func (*Org2OrgApplicationSettings) IsApplicationInstance added in v2.10.0 

func (a *Org2OrgApplicationSettings) IsApplicationInstance() bool

type Org2OrgApplicationSettingsApp added in v2.10.0 

type Org2OrgApplicationSettingsApp struct {
	AcsUrl         string `json:"acsUrl,omitempty"`
	AudRestriction string `json:"audRestriction,omitempty"`
	BaseUrl        string `json:"baseUrl,omitempty"`
}

func NewOrg2OrgApplicationSettingsApp added in v2.10.0 

func NewOrg2OrgApplicationSettingsApp() *Org2OrgApplicationSettingsApp

func (*Org2OrgApplicationSettingsApp) IsApplicationInstance added in v2.10.0 

func (a *Org2OrgApplicationSettingsApp) IsApplicationInstance() bool

type OrgContactType added in v2.8.0 

type OrgContactType string

type OrgContactTypeObj added in v2.8.0 

type OrgContactTypeObj struct {
	Links       interface{} `json:"_links,omitempty"`
	ContactType string      `json:"contactType,omitempty"`
}

type OrgContactUser added in v2.8.0 

type OrgContactUser struct {
	Links  interface{} `json:"_links,omitempty"`
	UserId string      `json:"userId,omitempty"`
}

type OrgContactUserResource added in v2.8.0 

type OrgContactUserResource resource

type OrgOktaCommunicationSetting added in v2.8.0 

type OrgOktaCommunicationSetting struct {
	Links            interface{} `json:"_links,omitempty"`
	OptOutEmailUsers *bool       `json:"optOutEmailUsers,omitempty"`
}

type OrgOktaCommunicationSettingResource added in v2.8.0 

type OrgOktaCommunicationSettingResource resource

type OrgOktaSupportSetting added in v2.8.0 

type OrgOktaSupportSetting string

type OrgOktaSupportSettingsObj added in v2.8.0 

type OrgOktaSupportSettingsObj struct {
	Links      interface{} `json:"_links,omitempty"`
	Expiration *time.Time  `json:"expiration,omitempty"`
	Support    string      `json:"support,omitempty"`
}

type OrgOktaSupportSettingsObjResource added in v2.8.0 

type OrgOktaSupportSettingsObjResource resource

type OrgPreferences added in v2.8.0 

type OrgPreferences struct {
	Links             interface{} `json:"_links,omitempty"`
	ShowEndUserFooter *bool       `json:"showEndUserFooter,omitempty"`
}

type OrgPreferencesResource added in v2.8.0 

type OrgPreferencesResource resource

type OrgSetting added in v2.8.0 

type OrgSetting struct {
	Links                 interface{} `json:"_links,omitempty"`
	Address1              string      `json:"address1,omitempty"`
	Address2              string      `json:"address2,omitempty"`
	City                  string      `json:"city,omitempty"`
	CompanyName           string      `json:"companyName,omitempty"`
	Country               string      `json:"country,omitempty"`
	Created               *time.Time  `json:"created,omitempty"`
	EndUserSupportHelpURL string      `json:"endUserSupportHelpURL,omitempty"`
	ExpiresAt             *time.Time  `json:"expiresAt,omitempty"`
	Id                    string      `json:"id,omitempty"`
	LastUpdated           *time.Time  `json:"lastUpdated,omitempty"`
	PhoneNumber           string      `json:"phoneNumber,omitempty"`
	PostalCode            string      `json:"postalCode,omitempty"`
	State                 string      `json:"state,omitempty"`
	Status                string      `json:"status,omitempty"`
	Subdomain             string      `json:"subdomain,omitempty"`
	SupportPhoneNumber    string      `json:"supportPhoneNumber,omitempty"`
	Website               string      `json:"website,omitempty"`
}

type OrgSettingResource added in v2.8.0 

type OrgSettingResource resource

func (*OrgSettingResource) ExtendOktaSupport added in v2.8.0 

func (m *OrgSettingResource) ExtendOktaSupport(ctx context.Context) (*OrgOktaSupportSettingsObj, *Response, error)

Extends the length of time that Okta Support can access your org by 24 hours. This means that 24 hours are added to the remaining access time.

func (*OrgSettingResource) GetOktaCommunicationSettings added in v2.8.0 

func (m *OrgSettingResource) GetOktaCommunicationSettings(ctx context.Context) (*OrgOktaCommunicationSetting, *Response, error)

Gets Okta Communication Settings of your organization.

func (*OrgSettingResource) GetOrgContactTypes added in v2.8.0 

func (m *OrgSettingResource) GetOrgContactTypes(ctx context.Context) ([]*OrgContactTypeObj, *Response, error)

Gets Contact Types of your organization.

func (*OrgSettingResource) GetOrgContactUser added in v2.8.0 

func (m *OrgSettingResource) GetOrgContactUser(ctx context.Context, contactType string) (*OrgContactUser, *Response, error)

Retrieves the URL of the User associated with the specified Contact Type.

func (*OrgSettingResource) GetOrgOktaSupportSettings added in v2.8.0 

func (m *OrgSettingResource) GetOrgOktaSupportSettings(ctx context.Context) (*OrgOktaSupportSettingsObj, *Response, error)

Gets Okta Support Settings of your organization.

func (*OrgSettingResource) GetOrgPreferences added in v2.8.0 

func (m *OrgSettingResource) GetOrgPreferences(ctx context.Context) (*OrgPreferences, *Response, error)

Gets preferences of your organization.

func (*OrgSettingResource) GetOrgSettings added in v2.8.0 

func (m *OrgSettingResource) GetOrgSettings(ctx context.Context) (*OrgSetting, *Response, error)

Get settings of your organization.

func (*OrgSettingResource) GrantOktaSupport added in v2.8.0 

func (m *OrgSettingResource) GrantOktaSupport(ctx context.Context) (*OrgOktaSupportSettingsObj, *Response, error)

Enables you to temporarily allow Okta Support to access your org as an administrator for eight hours.

func (*OrgSettingResource) HideOktaUIFooter added in v2.8.0 

func (m *OrgSettingResource) HideOktaUIFooter(ctx context.Context) (*OrgPreferences, *Response, error)

Hide the Okta UI footer for all end users of your organization.

func (*OrgSettingResource) OptInUsersToOktaCommunicationEmails added in v2.8.0 

func (m *OrgSettingResource) OptInUsersToOktaCommunicationEmails(ctx context.Context) (*OrgOktaCommunicationSetting, *Response, error)

Opts in all users of this org to Okta Communication emails.

func (*OrgSettingResource) OptOutUsersFromOktaCommunicationEmails added in v2.8.0 

func (m *OrgSettingResource) OptOutUsersFromOktaCommunicationEmails(ctx context.Context) (*OrgOktaCommunicationSetting, *Response, error)

Opts out all users of this org from Okta Communication emails.

func (*OrgSettingResource) PartialUpdateOrgSetting added in v2.8.0 

func (m *OrgSettingResource) PartialUpdateOrgSetting(ctx context.Context, body OrgSetting) (*OrgSetting, *Response, error)

Partial update settings of your organization.

func (*OrgSettingResource) RevokeOktaSupport added in v2.8.0 

func (m *OrgSettingResource) RevokeOktaSupport(ctx context.Context) (*OrgOktaSupportSettingsObj, *Response, error)

Revokes Okta Support access to your organization.

func (*OrgSettingResource) ShowOktaUIFooter added in v2.8.0 

func (m *OrgSettingResource) ShowOktaUIFooter(ctx context.Context) (*OrgPreferences, *Response, error)

Makes the Okta UI footer visible for all end users of your organization.

func (*OrgSettingResource) UpdateOrgContactUser added in v2.8.0 

func (m *OrgSettingResource) UpdateOrgContactUser(ctx context.Context, contactType string, body UserIdString) (*OrgContactUser, *Response, error)

Updates the User associated with the specified Contact Type. 

func (m *OrgSettingResource) UpdateOrgLogo(ctx context.Context, file string) (*Response, error)

Updates the logo for your organization.

func (*OrgSettingResource) UpdateOrgSetting added in v2.8.0 

func (m *OrgSettingResource) UpdateOrgSetting(ctx context.Context, body OrgSetting) (*OrgSetting, *Response, error)

Update settings of your organization.

type PasswordCredential 

type PasswordCredential struct {
	Hash  *PasswordCredentialHash `json:"hash,omitempty"`
	Hook  *PasswordCredentialHook `json:"hook,omitempty"`
	Value string                  `json:"value,omitempty"`
}

type PasswordCredentialHash 

type PasswordCredentialHash struct {
	Algorithm     string `json:"algorithm,omitempty"`
	Salt          string `json:"salt,omitempty"`
	SaltOrder     string `json:"saltOrder,omitempty"`
	Value         string `json:"value,omitempty"`
	WorkFactor    int64  `json:"-"`
	WorkFactorPtr *int64 `json:"workFactor,omitempty"`
}

func (*PasswordCredentialHash) MarshalJSON added in v2.17.0 

func (a *PasswordCredentialHash) MarshalJSON() ([]byte, error)

func (*PasswordCredentialHash) UnmarshalJSON added in v2.17.0 

func (a *PasswordCredentialHash) UnmarshalJSON(data []byte) error

type PasswordCredentialHashAlgorithm 

type PasswordCredentialHashAlgorithm string

type PasswordCredentialHook 

type PasswordCredentialHook struct {
	Type string `json:"type,omitempty"`
}

type PasswordDictionary 

type PasswordDictionary struct {
	Common *PasswordDictionaryCommon `json:"common,omitempty"`
}

func NewPasswordDictionary added in v2.10.1 

func NewPasswordDictionary() *PasswordDictionary

func (*PasswordDictionary) IsPolicyInstance added in v2.10.1 

func (a *PasswordDictionary) IsPolicyInstance() bool

type PasswordDictionaryCommon 

type PasswordDictionaryCommon struct {
	Exclude *bool `json:"exclude,omitempty"`
}

func NewPasswordDictionaryCommon added in v2.10.1 

func NewPasswordDictionaryCommon() *PasswordDictionaryCommon

func (*PasswordDictionaryCommon) IsPolicyInstance added in v2.10.1 

func (a *PasswordDictionaryCommon) IsPolicyInstance() bool

type PasswordExpirationPolicyRuleCondition 

type PasswordExpirationPolicyRuleCondition struct {
	Number    int64  `json:"-"`
	NumberPtr *int64 `json:"number,omitempty"`
	Unit      string `json:"unit,omitempty"`
}

func NewPasswordExpirationPolicyRuleCondition added in v2.10.1 

func NewPasswordExpirationPolicyRuleCondition() *PasswordExpirationPolicyRuleCondition

func (*PasswordExpirationPolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *PasswordExpirationPolicyRuleCondition) IsPolicyInstance() bool

func (*PasswordExpirationPolicyRuleCondition) MarshalJSON added in v2.17.0 

func (a *PasswordExpirationPolicyRuleCondition) MarshalJSON() ([]byte, error)

func (*PasswordExpirationPolicyRuleCondition) UnmarshalJSON added in v2.17.0 

func (a *PasswordExpirationPolicyRuleCondition) UnmarshalJSON(data []byte) error

type PasswordPolicy 

type PasswordPolicy struct {
	Embedded    interface{}               `json:"_embedded,omitempty"`
	Links       interface{}               `json:"_links,omitempty"`
	Conditions  *PasswordPolicyConditions `json:"conditions,omitempty"`
	Created     *time.Time                `json:"created,omitempty"`
	Description string                    `json:"description,omitempty"`
	Id          string                    `json:"id,omitempty"`
	LastUpdated *time.Time                `json:"lastUpdated,omitempty"`
	Name        string                    `json:"name,omitempty"`
	Priority    int64                     `json:"-"`
	PriorityPtr *int64                    `json:"priority,omitempty"`
	Status      string                    `json:"status,omitempty"`
	System      *bool                     `json:"system,omitempty"`
	Type        string                    `json:"type,omitempty"`
	Settings    *PasswordPolicySettings   `json:"settings,omitempty"`
}

func NewPasswordPolicy added in v2.10.1 

func NewPasswordPolicy() *PasswordPolicy

func (*PasswordPolicy) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicy) IsPolicyInstance() bool

func (*PasswordPolicy) MarshalJSON added in v2.17.0 

func (a *PasswordPolicy) MarshalJSON() ([]byte, error)

func (*PasswordPolicy) UnmarshalJSON added in v2.17.0 

func (a *PasswordPolicy) UnmarshalJSON(data []byte) error

type PasswordPolicyAuthenticationProviderCondition 

type PasswordPolicyAuthenticationProviderCondition struct {
	Include  []string `json:"include,omitempty"`
	Provider string   `json:"provider,omitempty"`
}

func NewPasswordPolicyAuthenticationProviderCondition added in v2.10.1 

func NewPasswordPolicyAuthenticationProviderCondition() *PasswordPolicyAuthenticationProviderCondition

func (*PasswordPolicyAuthenticationProviderCondition) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyAuthenticationProviderCondition) IsPolicyInstance() bool

type PasswordPolicyConditions 

type PasswordPolicyConditions struct {
	App                   *AppAndInstancePolicyRuleCondition             `json:"app,omitempty"`
	Apps                  *AppInstancePolicyRuleCondition                `json:"apps,omitempty"`
	AuthContext           *PolicyRuleAuthContextCondition                `json:"authContext,omitempty"`
	AuthProvider          *PasswordPolicyAuthenticationProviderCondition `json:"authProvider,omitempty"`
	BeforeScheduledAction *BeforeScheduledActionPolicyRuleCondition      `json:"beforeScheduledAction,omitempty"`
	Clients               *ClientPolicyCondition                         `json:"clients,omitempty"`
	Context               *ContextPolicyRuleCondition                    `json:"context,omitempty"`
	Device                *DevicePolicyRuleCondition                     `json:"device,omitempty"`
	GrantTypes            *GrantTypePolicyRuleCondition                  `json:"grantTypes,omitempty"`
	Groups                *GroupPolicyRuleCondition                      `json:"groups,omitempty"`
	IdentityProvider      *IdentityProviderPolicyRuleCondition           `json:"identityProvider,omitempty"`
	MdmEnrollment         *MDMEnrollmentPolicyRuleCondition              `json:"mdmEnrollment,omitempty"`
	Network               *PolicyNetworkCondition                        `json:"network,omitempty"`
	People                *PolicyPeopleCondition                         `json:"people,omitempty"`
	Platform              *PlatformPolicyRuleCondition                   `json:"platform,omitempty"`
	Risk                  *RiskPolicyRuleCondition                       `json:"risk,omitempty"`
	RiskScore             *RiskScorePolicyRuleCondition                  `json:"riskScore,omitempty"`
	Scopes                *OAuth2ScopesMediationPolicyRuleCondition      `json:"scopes,omitempty"`
	UserIdentifier        *UserIdentifierPolicyRuleCondition             `json:"userIdentifier,omitempty"`
	UserStatus            *UserStatusPolicyRuleCondition                 `json:"userStatus,omitempty"`
	Users                 *UserPolicyRuleCondition                       `json:"users,omitempty"`
}

func NewPasswordPolicyConditions added in v2.10.1 

func NewPasswordPolicyConditions() *PasswordPolicyConditions

func (*PasswordPolicyConditions) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyConditions) IsPolicyInstance() bool

type PasswordPolicyDelegationSettings 

type PasswordPolicyDelegationSettings struct {
	Options *PasswordPolicyDelegationSettingsOptions `json:"options,omitempty"`
}

func NewPasswordPolicyDelegationSettings added in v2.10.1 

func NewPasswordPolicyDelegationSettings() *PasswordPolicyDelegationSettings

func (*PasswordPolicyDelegationSettings) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyDelegationSettings) IsPolicyInstance() bool

type PasswordPolicyDelegationSettingsOptions 

type PasswordPolicyDelegationSettingsOptions struct {
	SkipUnlock *bool `json:"skipUnlock,omitempty"`
}

func NewPasswordPolicyDelegationSettingsOptions added in v2.10.1 

func NewPasswordPolicyDelegationSettingsOptions() *PasswordPolicyDelegationSettingsOptions

func (*PasswordPolicyDelegationSettingsOptions) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyDelegationSettingsOptions) IsPolicyInstance() bool

type PasswordPolicyPasswordSettings 

type PasswordPolicyPasswordSettings struct {
	Age        *PasswordPolicyPasswordSettingsAge        `json:"age,omitempty"`
	Complexity *PasswordPolicyPasswordSettingsComplexity `json:"complexity,omitempty"`
	Lockout    *PasswordPolicyPasswordSettingsLockout    `json:"lockout,omitempty"`
}

func NewPasswordPolicyPasswordSettings added in v2.10.1 

func NewPasswordPolicyPasswordSettings() *PasswordPolicyPasswordSettings

func (*PasswordPolicyPasswordSettings) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyPasswordSettings) IsPolicyInstance() bool

type PasswordPolicyPasswordSettingsAge 

type PasswordPolicyPasswordSettingsAge struct {
	ExpireWarnDays    int64  `json:"-"`
	ExpireWarnDaysPtr *int64 `json:"expireWarnDays,omitempty"`
	HistoryCount      int64  `json:"-"`
	HistoryCountPtr   *int64 `json:"historyCount,omitempty"`
	MaxAgeDays        int64  `json:"-"`
	MaxAgeDaysPtr     *int64 `json:"maxAgeDays,omitempty"`
	MinAgeMinutes     int64  `json:"-"`
	MinAgeMinutesPtr  *int64 `json:"minAgeMinutes,omitempty"`
}

func NewPasswordPolicyPasswordSettingsAge added in v2.10.1 

func NewPasswordPolicyPasswordSettingsAge() *PasswordPolicyPasswordSettingsAge

func (*PasswordPolicyPasswordSettingsAge) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyPasswordSettingsAge) IsPolicyInstance() bool

func (*PasswordPolicyPasswordSettingsAge) MarshalJSON added in v2.17.0 

func (a *PasswordPolicyPasswordSettingsAge) MarshalJSON() ([]byte, error)

func (*PasswordPolicyPasswordSettingsAge) UnmarshalJSON added in v2.17.0 

func (a *PasswordPolicyPasswordSettingsAge) UnmarshalJSON(data []byte) error

type PasswordPolicyPasswordSettingsComplexity 

type PasswordPolicyPasswordSettingsComplexity struct {
	Dictionary        *PasswordDictionary `json:"dictionary,omitempty"`
	ExcludeAttributes []string            `json:"excludeAttributes,omitempty"`
	ExcludeUsername   *bool               `json:"excludeUsername,omitempty"`
	MinLength         int64               `json:"-"`
	MinLengthPtr      *int64              `json:"minLength,omitempty"`
	MinLowerCase      int64               `json:"-"`
	MinLowerCasePtr   *int64              `json:"minLowerCase"`
	MinNumber         int64               `json:"-"`
	MinNumberPtr      *int64              `json:"minNumber"`
	MinSymbol         int64               `json:"-"`
	MinSymbolPtr      *int64              `json:"minSymbol"`
	MinUpperCase      int64               `json:"-"`
	MinUpperCasePtr   *int64              `json:"minUpperCase"`
}

func NewPasswordPolicyPasswordSettingsComplexity added in v2.10.1 

func NewPasswordPolicyPasswordSettingsComplexity() *PasswordPolicyPasswordSettingsComplexity

func (*PasswordPolicyPasswordSettingsComplexity) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyPasswordSettingsComplexity) IsPolicyInstance() bool

func (*PasswordPolicyPasswordSettingsComplexity) MarshalJSON added in v2.17.0 

func (a *PasswordPolicyPasswordSettingsComplexity) MarshalJSON() ([]byte, error)

func (*PasswordPolicyPasswordSettingsComplexity) UnmarshalJSON added in v2.17.0 

func (a *PasswordPolicyPasswordSettingsComplexity) UnmarshalJSON(data []byte) error

type PasswordPolicyPasswordSettingsLockout 

type PasswordPolicyPasswordSettingsLockout struct {
	AutoUnlockMinutes               int64    `json:"-"`
	AutoUnlockMinutesPtr            *int64   `json:"autoUnlockMinutes,omitempty"`
	MaxAttempts                     int64    `json:"-"`
	MaxAttemptsPtr                  *int64   `json:"maxAttempts,omitempty"`
	ShowLockoutFailures             *bool    `json:"showLockoutFailures,omitempty"`
	UserLockoutNotificationChannels []string `json:"userLockoutNotificationChannels,omitempty"`
}

func NewPasswordPolicyPasswordSettingsLockout added in v2.10.1 

func NewPasswordPolicyPasswordSettingsLockout() *PasswordPolicyPasswordSettingsLockout

func (*PasswordPolicyPasswordSettingsLockout) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyPasswordSettingsLockout) IsPolicyInstance() bool

func (*PasswordPolicyPasswordSettingsLockout) MarshalJSON added in v2.17.0 

func (a *PasswordPolicyPasswordSettingsLockout) MarshalJSON() ([]byte, error)

func (*PasswordPolicyPasswordSettingsLockout) UnmarshalJSON added in v2.17.0 

func (a *PasswordPolicyPasswordSettingsLockout) UnmarshalJSON(data []byte) error

type PasswordPolicyRecoveryEmail 

type PasswordPolicyRecoveryEmail struct {
	Properties *PasswordPolicyRecoveryEmailProperties `json:"properties,omitempty"`
	Status     string                                 `json:"status,omitempty"`
}

func NewPasswordPolicyRecoveryEmail added in v2.10.1 

func NewPasswordPolicyRecoveryEmail() *PasswordPolicyRecoveryEmail

func (*PasswordPolicyRecoveryEmail) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyRecoveryEmail) IsPolicyInstance() bool

type PasswordPolicyRecoveryEmailProperties 

type PasswordPolicyRecoveryEmailProperties struct {
	RecoveryToken *PasswordPolicyRecoveryEmailRecoveryToken `json:"recoveryToken,omitempty"`
}

func NewPasswordPolicyRecoveryEmailProperties added in v2.10.1 

func NewPasswordPolicyRecoveryEmailProperties() *PasswordPolicyRecoveryEmailProperties

func (*PasswordPolicyRecoveryEmailProperties) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyRecoveryEmailProperties) IsPolicyInstance() bool

type PasswordPolicyRecoveryEmailRecoveryToken 

type PasswordPolicyRecoveryEmailRecoveryToken struct {
	TokenLifetimeMinutes    int64  `json:"-"`
	TokenLifetimeMinutesPtr *int64 `json:"tokenLifetimeMinutes"`
}

func NewPasswordPolicyRecoveryEmailRecoveryToken added in v2.10.1 

func NewPasswordPolicyRecoveryEmailRecoveryToken() *PasswordPolicyRecoveryEmailRecoveryToken

func (*PasswordPolicyRecoveryEmailRecoveryToken) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyRecoveryEmailRecoveryToken) IsPolicyInstance() bool

func (*PasswordPolicyRecoveryEmailRecoveryToken) MarshalJSON added in v2.17.0 

func (a *PasswordPolicyRecoveryEmailRecoveryToken) MarshalJSON() ([]byte, error)

func (*PasswordPolicyRecoveryEmailRecoveryToken) UnmarshalJSON added in v2.17.0 

func (a *PasswordPolicyRecoveryEmailRecoveryToken) UnmarshalJSON(data []byte) error

type PasswordPolicyRecoveryFactorSettings 

type PasswordPolicyRecoveryFactorSettings struct {
	Status string `json:"status,omitempty"`
}

func NewPasswordPolicyRecoveryFactorSettings added in v2.10.1 

func NewPasswordPolicyRecoveryFactorSettings() *PasswordPolicyRecoveryFactorSettings

func (*PasswordPolicyRecoveryFactorSettings) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyRecoveryFactorSettings) IsPolicyInstance() bool

type PasswordPolicyRecoveryFactors 

type PasswordPolicyRecoveryFactors struct {
	OktaCall         *PasswordPolicyRecoveryFactorSettings `json:"okta_call,omitempty"`
	OktaEmail        *PasswordPolicyRecoveryEmail          `json:"okta_email,omitempty"`
	OktaSms          *PasswordPolicyRecoveryFactorSettings `json:"okta_sms,omitempty"`
	RecoveryQuestion *PasswordPolicyRecoveryQuestion       `json:"recovery_question,omitempty"`
}

func NewPasswordPolicyRecoveryFactors added in v2.10.1 

func NewPasswordPolicyRecoveryFactors() *PasswordPolicyRecoveryFactors

func (*PasswordPolicyRecoveryFactors) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyRecoveryFactors) IsPolicyInstance() bool

type PasswordPolicyRecoveryQuestion 

type PasswordPolicyRecoveryQuestion struct {
	Properties *PasswordPolicyRecoveryQuestionProperties `json:"properties,omitempty"`
	Status     string                                    `json:"status,omitempty"`
}

func NewPasswordPolicyRecoveryQuestion added in v2.10.1 

func NewPasswordPolicyRecoveryQuestion() *PasswordPolicyRecoveryQuestion

func (*PasswordPolicyRecoveryQuestion) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyRecoveryQuestion) IsPolicyInstance() bool

type PasswordPolicyRecoveryQuestionComplexity 

type PasswordPolicyRecoveryQuestionComplexity struct {
	MinLength    int64  `json:"-"`
	MinLengthPtr *int64 `json:"minLength,omitempty"`
}

func NewPasswordPolicyRecoveryQuestionComplexity added in v2.10.1 

func NewPasswordPolicyRecoveryQuestionComplexity() *PasswordPolicyRecoveryQuestionComplexity

func (*PasswordPolicyRecoveryQuestionComplexity) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyRecoveryQuestionComplexity) IsPolicyInstance() bool

func (*PasswordPolicyRecoveryQuestionComplexity) MarshalJSON added in v2.17.0 

func (a *PasswordPolicyRecoveryQuestionComplexity) MarshalJSON() ([]byte, error)

func (*PasswordPolicyRecoveryQuestionComplexity) UnmarshalJSON added in v2.17.0 

func (a *PasswordPolicyRecoveryQuestionComplexity) UnmarshalJSON(data []byte) error

type PasswordPolicyRecoveryQuestionProperties 

type PasswordPolicyRecoveryQuestionProperties struct {
	Complexity *PasswordPolicyRecoveryQuestionComplexity `json:"complexity,omitempty"`
}

func NewPasswordPolicyRecoveryQuestionProperties added in v2.10.1 

func NewPasswordPolicyRecoveryQuestionProperties() *PasswordPolicyRecoveryQuestionProperties

func (*PasswordPolicyRecoveryQuestionProperties) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyRecoveryQuestionProperties) IsPolicyInstance() bool

type PasswordPolicyRecoverySettings 

type PasswordPolicyRecoverySettings struct {
	Factors *PasswordPolicyRecoveryFactors `json:"factors,omitempty"`
}

func NewPasswordPolicyRecoverySettings added in v2.10.1 

func NewPasswordPolicyRecoverySettings() *PasswordPolicyRecoverySettings

func (*PasswordPolicyRecoverySettings) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyRecoverySettings) IsPolicyInstance() bool

type PasswordPolicyRule 

type PasswordPolicyRule struct {
	Actions     *PasswordPolicyRuleActions    `json:"actions,omitempty"`
	Conditions  *PasswordPolicyRuleConditions `json:"conditions,omitempty"`
	Created     *time.Time                    `json:"created,omitempty"`
	Id          string                        `json:"id,omitempty"`
	LastUpdated *time.Time                    `json:"lastUpdated,omitempty"`
	Name        string                        `json:"name,omitempty"`
	Priority    int64                         `json:"-"`
	PriorityPtr *int64                        `json:"priority,omitempty"`
	Status      string                        `json:"status,omitempty"`
	System      *bool                         `json:"system,omitempty"`
	Type        string                        `json:"type,omitempty"`
}

func NewPasswordPolicyRule added in v2.10.1 

func NewPasswordPolicyRule() *PasswordPolicyRule

func (*PasswordPolicyRule) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyRule) IsPolicyInstance() bool

func (*PasswordPolicyRule) MarshalJSON added in v2.17.0 

func (a *PasswordPolicyRule) MarshalJSON() ([]byte, error)

func (*PasswordPolicyRule) UnmarshalJSON added in v2.17.0 

func (a *PasswordPolicyRule) UnmarshalJSON(data []byte) error

type PasswordPolicyRuleAction 

type PasswordPolicyRuleAction struct {
	Access string `json:"access,omitempty"`
}

func NewPasswordPolicyRuleAction added in v2.10.1 

func NewPasswordPolicyRuleAction() *PasswordPolicyRuleAction

func (*PasswordPolicyRuleAction) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyRuleAction) IsPolicyInstance() bool

type PasswordPolicyRuleActions 

type PasswordPolicyRuleActions struct {
	Enroll                   *PolicyRuleActionsEnroll           `json:"enroll,omitempty"`
	Idp                      *IdpPolicyRuleAction               `json:"idp,omitempty"`
	PasswordChange           *PasswordPolicyRuleAction          `json:"passwordChange,omitempty"`
	SelfServicePasswordReset *PasswordPolicyRuleAction          `json:"selfServicePasswordReset,omitempty"`
	SelfServiceUnlock        *PasswordPolicyRuleAction          `json:"selfServiceUnlock,omitempty"`
	Signon                   *OktaSignOnPolicyRuleSignonActions `json:"signon,omitempty"`
}

func NewPasswordPolicyRuleActions added in v2.10.1 

func NewPasswordPolicyRuleActions() *PasswordPolicyRuleActions

func (*PasswordPolicyRuleActions) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyRuleActions) IsPolicyInstance() bool

type PasswordPolicyRuleConditions 

type PasswordPolicyRuleConditions struct {
	App                   *AppAndInstancePolicyRuleCondition             `json:"app,omitempty"`
	Apps                  *AppInstancePolicyRuleCondition                `json:"apps,omitempty"`
	AuthContext           *PolicyRuleAuthContextCondition                `json:"authContext,omitempty"`
	AuthProvider          *PasswordPolicyAuthenticationProviderCondition `json:"authProvider,omitempty"`
	BeforeScheduledAction *BeforeScheduledActionPolicyRuleCondition      `json:"beforeScheduledAction,omitempty"`
	Clients               *ClientPolicyCondition                         `json:"clients,omitempty"`
	Context               *ContextPolicyRuleCondition                    `json:"context,omitempty"`
	Device                *DevicePolicyRuleCondition                     `json:"device,omitempty"`
	GrantTypes            *GrantTypePolicyRuleCondition                  `json:"grantTypes,omitempty"`
	Groups                *GroupPolicyRuleCondition                      `json:"groups,omitempty"`
	IdentityProvider      *IdentityProviderPolicyRuleCondition           `json:"identityProvider,omitempty"`
	MdmEnrollment         *MDMEnrollmentPolicyRuleCondition              `json:"mdmEnrollment,omitempty"`
	Network               *PolicyNetworkCondition                        `json:"network,omitempty"`
	People                *PolicyPeopleCondition                         `json:"people,omitempty"`
	Platform              *PlatformPolicyRuleCondition                   `json:"platform,omitempty"`
	Risk                  *RiskPolicyRuleCondition                       `json:"risk,omitempty"`
	RiskScore             *RiskScorePolicyRuleCondition                  `json:"riskScore,omitempty"`
	Scopes                *OAuth2ScopesMediationPolicyRuleCondition      `json:"scopes,omitempty"`
	UserIdentifier        *UserIdentifierPolicyRuleCondition             `json:"userIdentifier,omitempty"`
	UserStatus            *UserStatusPolicyRuleCondition                 `json:"userStatus,omitempty"`
	Users                 *UserPolicyRuleCondition                       `json:"users,omitempty"`
}

func NewPasswordPolicyRuleConditions added in v2.10.1 

func NewPasswordPolicyRuleConditions() *PasswordPolicyRuleConditions

func (*PasswordPolicyRuleConditions) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicyRuleConditions) IsPolicyInstance() bool

type PasswordPolicySettings 

type PasswordPolicySettings struct {
	Delegation *PasswordPolicyDelegationSettings `json:"delegation,omitempty"`
	Password   *PasswordPolicyPasswordSettings   `json:"password,omitempty"`
	Recovery   *PasswordPolicyRecoverySettings   `json:"recovery,omitempty"`
}

func NewPasswordPolicySettings added in v2.10.1 

func NewPasswordPolicySettings() *PasswordPolicySettings

func (*PasswordPolicySettings) IsPolicyInstance added in v2.10.1 

func (a *PasswordPolicySettings) IsPolicyInstance() bool

type PasswordSettingObject added in v2.10.0 

type PasswordSettingObject struct {
	Change string `json:"change,omitempty"`
	Seed   string `json:"seed,omitempty"`
	Status string `json:"status,omitempty"`
}

func NewPasswordSettingObject added in v2.10.0 

func NewPasswordSettingObject() *PasswordSettingObject

func (*PasswordSettingObject) IsApplicationInstance added in v2.10.0 

func (a *PasswordSettingObject) IsApplicationInstance() bool

type PlatformConditionEvaluatorPlatform 

type PlatformConditionEvaluatorPlatform struct {
	Os   *PlatformConditionEvaluatorPlatformOperatingSystem `json:"os,omitempty"`
	Type string                                             `json:"type,omitempty"`
}

func NewPlatformConditionEvaluatorPlatform added in v2.10.1 

func NewPlatformConditionEvaluatorPlatform() *PlatformConditionEvaluatorPlatform

func (*PlatformConditionEvaluatorPlatform) IsPolicyInstance added in v2.10.1 

func (a *PlatformConditionEvaluatorPlatform) IsPolicyInstance() bool

type PlatformConditionEvaluatorPlatformOperatingSystem 

type PlatformConditionEvaluatorPlatformOperatingSystem struct {
	Expression string                                                    `json:"expression,omitempty"`
	Type       string                                                    `json:"type,omitempty"`
	Version    *PlatformConditionEvaluatorPlatformOperatingSystemVersion `json:"version,omitempty"`
}

func NewPlatformConditionEvaluatorPlatformOperatingSystem added in v2.10.1 

func NewPlatformConditionEvaluatorPlatformOperatingSystem() *PlatformConditionEvaluatorPlatformOperatingSystem

func (*PlatformConditionEvaluatorPlatformOperatingSystem) IsPolicyInstance added in v2.10.1 

func (a *PlatformConditionEvaluatorPlatformOperatingSystem) IsPolicyInstance() bool

type PlatformConditionEvaluatorPlatformOperatingSystemVersion 

type PlatformConditionEvaluatorPlatformOperatingSystemVersion struct {
	MatchType string `json:"matchType,omitempty"`
	Value     string `json:"value,omitempty"`
}

func NewPlatformConditionEvaluatorPlatformOperatingSystemVersion added in v2.10.1 

func NewPlatformConditionEvaluatorPlatformOperatingSystemVersion() *PlatformConditionEvaluatorPlatformOperatingSystemVersion

func (*PlatformConditionEvaluatorPlatformOperatingSystemVersion) IsPolicyInstance added in v2.10.1 

func (a *PlatformConditionEvaluatorPlatformOperatingSystemVersion) IsPolicyInstance() bool

type PlatformPolicyRuleCondition 

type PlatformPolicyRuleCondition struct {
	Exclude []*PlatformConditionEvaluatorPlatform `json:"exclude,omitempty"`
	Include []*PlatformConditionEvaluatorPlatform `json:"include,omitempty"`
}

func NewPlatformPolicyRuleCondition added in v2.10.1 

func NewPlatformPolicyRuleCondition() *PlatformPolicyRuleCondition

func (*PlatformPolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *PlatformPolicyRuleCondition) IsPolicyInstance() bool

type Policies added in v2.12.0 

type Policies interface {
	IsPolicyInstance() bool
}

type Policy 

type Policy struct {
	Embedded    interface{}           `json:"_embedded,omitempty"`
	Links       interface{}           `json:"_links,omitempty"`
	Conditions  *PolicyRuleConditions `json:"conditions,omitempty"`
	Created     *time.Time            `json:"created,omitempty"`
	Description string                `json:"description,omitempty"`
	Id          string                `json:"id,omitempty"`
	LastUpdated *time.Time            `json:"lastUpdated,omitempty"`
	Name        string                `json:"name,omitempty"`
	Priority    int64                 `json:"-"`
	PriorityPtr *int64                `json:"priority,omitempty"`
	Status      string                `json:"status,omitempty"`
	System      *bool                 `json:"system,omitempty"`
	Type        string                `json:"type,omitempty"`
}

func NewPolicy added in v2.10.1 

func NewPolicy() *Policy

func (*Policy) IsPolicyInstance added in v2.10.1 

func (a *Policy) IsPolicyInstance() bool

func (*Policy) MarshalJSON added in v2.17.0 

func (a *Policy) MarshalJSON() ([]byte, error)

func (*Policy) UnmarshalJSON added in v2.17.0 

func (a *Policy) UnmarshalJSON(data []byte) error
type PolicyAccountLink struct {
	Action string                   `json:"action,omitempty"`
	Filter *PolicyAccountLinkFilter `json:"filter,omitempty"`
}
func NewPolicyAccountLink() *PolicyAccountLink

func (*PolicyAccountLink) IsPolicyInstance added in v2.10.1 

func (a *PolicyAccountLink) IsPolicyInstance() bool

type PolicyAccountLinkFilter 

type PolicyAccountLinkFilter struct {
	Groups *PolicyAccountLinkFilterGroups `json:"groups,omitempty"`
}

func NewPolicyAccountLinkFilter added in v2.10.1 

func NewPolicyAccountLinkFilter() *PolicyAccountLinkFilter

func (*PolicyAccountLinkFilter) IsPolicyInstance added in v2.10.1 

func (a *PolicyAccountLinkFilter) IsPolicyInstance() bool

type PolicyAccountLinkFilterGroups 

type PolicyAccountLinkFilterGroups struct {
	Include []string `json:"include,omitempty"`
}

func NewPolicyAccountLinkFilterGroups added in v2.10.1 

func NewPolicyAccountLinkFilterGroups() *PolicyAccountLinkFilterGroups

func (*PolicyAccountLinkFilterGroups) IsPolicyInstance added in v2.10.1 

func (a *PolicyAccountLinkFilterGroups) IsPolicyInstance() bool

type PolicyNetworkCondition 

type PolicyNetworkCondition struct {
	Connection string   `json:"connection,omitempty"`
	Exclude    []string `json:"exclude,omitempty"`
	Include    []string `json:"include,omitempty"`
}

func NewPolicyNetworkCondition added in v2.10.1 

func NewPolicyNetworkCondition() *PolicyNetworkCondition

func (*PolicyNetworkCondition) IsPolicyInstance added in v2.10.1 

func (a *PolicyNetworkCondition) IsPolicyInstance() bool

type PolicyPeopleCondition 

type PolicyPeopleCondition struct {
	Groups *GroupCondition `json:"groups,omitempty"`
	Users  *UserCondition  `json:"users,omitempty"`
}

func NewPolicyPeopleCondition added in v2.10.1 

func NewPolicyPeopleCondition() *PolicyPeopleCondition

func (*PolicyPeopleCondition) IsPolicyInstance added in v2.10.1 

func (a *PolicyPeopleCondition) IsPolicyInstance() bool

type PolicyResource 

type PolicyResource resource

func (*PolicyResource) ActivatePolicy 

func (m *PolicyResource) ActivatePolicy(ctx context.Context, policyId string) (*Response, error)

Activates a policy.

func (*PolicyResource) ActivatePolicyRule 

func (m *PolicyResource) ActivatePolicyRule(ctx context.Context, policyId string, ruleId string) (*Response, error)

Activates a policy rule.

func (*PolicyResource) CreatePolicy 

func (m *PolicyResource) CreatePolicy(ctx context.Context, body Policies, qp *query.Params) (Policies, *Response, error)

Creates a policy.

func (*PolicyResource) CreatePolicyRule 

func (m *PolicyResource) CreatePolicyRule(ctx context.Context, policyId string, body PolicyRule) (*PolicyRule, *Response, error)

Creates a policy rule.

func (*PolicyResource) DeactivatePolicy 

func (m *PolicyResource) DeactivatePolicy(ctx context.Context, policyId string) (*Response, error)

Deactivates a policy.

func (*PolicyResource) DeactivatePolicyRule 

func (m *PolicyResource) DeactivatePolicyRule(ctx context.Context, policyId string, ruleId string) (*Response, error)

Deactivates a policy rule.

func (*PolicyResource) DeletePolicy 

func (m *PolicyResource) DeletePolicy(ctx context.Context, policyId string) (*Response, error)

Removes a policy.

func (*PolicyResource) DeletePolicyRule 

func (m *PolicyResource) DeletePolicyRule(ctx context.Context, policyId string, ruleId string) (*Response, error)

Removes a policy rule.

func (*PolicyResource) GetPolicy 

func (m *PolicyResource) GetPolicy(ctx context.Context, policyId string, policyInstance Policies, qp *query.Params) (Policies, *Response, error)

Gets a policy.

func (*PolicyResource) GetPolicyRule 

func (m *PolicyResource) GetPolicyRule(ctx context.Context, policyId string, ruleId string) (*PolicyRule, *Response, error)

Gets a policy rule.

func (*PolicyResource) ListPolicies 

func (m *PolicyResource) ListPolicies(ctx context.Context, qp *query.Params) ([]Policies, *Response, error)

Gets all policies with the specified type.

func (*PolicyResource) ListPolicyRules 

func (m *PolicyResource) ListPolicyRules(ctx context.Context, policyId string) ([]*PolicyRule, *Response, error)

Enumerates all policy rules.

func (*PolicyResource) UpdatePolicy 

func (m *PolicyResource) UpdatePolicy(ctx context.Context, policyId string, body Policies) (Policies, *Response, error)

Updates a policy.

func (*PolicyResource) UpdatePolicyRule 

func (m *PolicyResource) UpdatePolicyRule(ctx context.Context, policyId string, ruleId string, body PolicyRule) (*PolicyRule, *Response, error)

Updates a policy rule.

type PolicyRule 

type PolicyRule struct {
	Actions     *PolicyRuleActions    `json:"actions,omitempty"`
	Conditions  *PolicyRuleConditions `json:"conditions,omitempty"`
	Created     *time.Time            `json:"created,omitempty"`
	Id          string                `json:"id,omitempty"`
	LastUpdated *time.Time            `json:"lastUpdated,omitempty"`
	Name        string                `json:"name,omitempty"`
	Priority    int64                 `json:"-"`
	PriorityPtr *int64                `json:"priority,omitempty"`
	Status      string                `json:"status,omitempty"`
	System      *bool                 `json:"system,omitempty"`
	Type        string                `json:"type,omitempty"`
}

func NewPolicyRule added in v2.10.1 

func NewPolicyRule() *PolicyRule

func (*PolicyRule) IsPolicyInstance added in v2.10.1 

func (a *PolicyRule) IsPolicyInstance() bool

func (*PolicyRule) MarshalJSON added in v2.17.0 

func (a *PolicyRule) MarshalJSON() ([]byte, error)

func (*PolicyRule) UnmarshalJSON added in v2.17.0 

func (a *PolicyRule) UnmarshalJSON(data []byte) error

type PolicyRuleActions added in v2.5.2 

type PolicyRuleActions struct {
	Enroll                   *PolicyRuleActionsEnroll           `json:"enroll,omitempty"`
	Idp                      *IdpPolicyRuleAction               `json:"idp,omitempty"`
	PasswordChange           *PasswordPolicyRuleAction          `json:"passwordChange,omitempty"`
	SelfServicePasswordReset *PasswordPolicyRuleAction          `json:"selfServicePasswordReset,omitempty"`
	SelfServiceUnlock        *PasswordPolicyRuleAction          `json:"selfServiceUnlock,omitempty"`
	Signon                   *OktaSignOnPolicyRuleSignonActions `json:"signon,omitempty"`
}

func NewPolicyRuleActions added in v2.10.1 

func NewPolicyRuleActions() *PolicyRuleActions

func (*PolicyRuleActions) IsPolicyInstance added in v2.10.1 

func (a *PolicyRuleActions) IsPolicyInstance() bool

type PolicyRuleActionsEnroll added in v2.5.2 

type PolicyRuleActionsEnroll struct {
	Self string `json:"self,omitempty"`
}

func NewPolicyRuleActionsEnroll added in v2.10.1 

func NewPolicyRuleActionsEnroll() *PolicyRuleActionsEnroll

func (*PolicyRuleActionsEnroll) IsPolicyInstance added in v2.10.1 

func (a *PolicyRuleActionsEnroll) IsPolicyInstance() bool

type PolicyRuleActionsEnrollSelf added in v2.5.2 

type PolicyRuleActionsEnrollSelf string

type PolicyRuleAuthContextCondition 

type PolicyRuleAuthContextCondition struct {
	AuthType string `json:"authType,omitempty"`
}

func NewPolicyRuleAuthContextCondition added in v2.10.1 

func NewPolicyRuleAuthContextCondition() *PolicyRuleAuthContextCondition

func (*PolicyRuleAuthContextCondition) IsPolicyInstance added in v2.10.1 

func (a *PolicyRuleAuthContextCondition) IsPolicyInstance() bool

type PolicyRuleConditions 

type PolicyRuleConditions struct {
	App                   *AppAndInstancePolicyRuleCondition             `json:"app,omitempty"`
	Apps                  *AppInstancePolicyRuleCondition                `json:"apps,omitempty"`
	AuthContext           *PolicyRuleAuthContextCondition                `json:"authContext,omitempty"`
	AuthProvider          *PasswordPolicyAuthenticationProviderCondition `json:"authProvider,omitempty"`
	BeforeScheduledAction *BeforeScheduledActionPolicyRuleCondition      `json:"beforeScheduledAction,omitempty"`
	Clients               *ClientPolicyCondition                         `json:"clients,omitempty"`
	Context               *ContextPolicyRuleCondition                    `json:"context,omitempty"`
	Device                *DevicePolicyRuleCondition                     `json:"device,omitempty"`
	GrantTypes            *GrantTypePolicyRuleCondition                  `json:"grantTypes,omitempty"`
	Groups                *GroupPolicyRuleCondition                      `json:"groups,omitempty"`
	IdentityProvider      *IdentityProviderPolicyRuleCondition           `json:"identityProvider,omitempty"`
	MdmEnrollment         *MDMEnrollmentPolicyRuleCondition              `json:"mdmEnrollment,omitempty"`
	Network               *PolicyNetworkCondition                        `json:"network,omitempty"`
	People                *PolicyPeopleCondition                         `json:"people,omitempty"`
	Platform              *PlatformPolicyRuleCondition                   `json:"platform,omitempty"`
	Risk                  *RiskPolicyRuleCondition                       `json:"risk,omitempty"`
	RiskScore             *RiskScorePolicyRuleCondition                  `json:"riskScore,omitempty"`
	Scopes                *OAuth2ScopesMediationPolicyRuleCondition      `json:"scopes,omitempty"`
	UserIdentifier        *UserIdentifierPolicyRuleCondition             `json:"userIdentifier,omitempty"`
	UserStatus            *UserStatusPolicyRuleCondition                 `json:"userStatus,omitempty"`
	Users                 *UserPolicyRuleCondition                       `json:"users,omitempty"`
}

func NewPolicyRuleConditions added in v2.10.1 

func NewPolicyRuleConditions() *PolicyRuleConditions

func (*PolicyRuleConditions) IsPolicyInstance added in v2.10.1 

func (a *PolicyRuleConditions) IsPolicyInstance() bool

type PolicyRuleResource 

type PolicyRuleResource resource

func (*PolicyRuleResource) DeletePolicyRule 

func (m *PolicyRuleResource) DeletePolicyRule(ctx context.Context, policyId string, ruleId string) (*Response, error)

Removes a policy rule.

func (*PolicyRuleResource) UpdatePolicyRule 

func (m *PolicyRuleResource) UpdatePolicyRule(ctx context.Context, policyId string, ruleId string, body PolicyRule) (*PolicyRule, *Response, error)

Updates a policy rule.

type PolicySubject 

type PolicySubject struct {
	Filter           string                  `json:"filter,omitempty"`
	Format           []string                `json:"format,omitempty"`
	MatchAttribute   string                  `json:"matchAttribute,omitempty"`
	MatchType        string                  `json:"matchType,omitempty"`
	UserNameTemplate *PolicyUserNameTemplate `json:"userNameTemplate,omitempty"`
}

func NewPolicySubject added in v2.10.1 

func NewPolicySubject() *PolicySubject

func (*PolicySubject) IsPolicyInstance added in v2.10.1 

func (a *PolicySubject) IsPolicyInstance() bool

type PolicySubjectMatchType 

type PolicySubjectMatchType string

type PolicyType 

type PolicyType string

type PolicyUserNameTemplate 

type PolicyUserNameTemplate struct {
	Template string `json:"template,omitempty"`
}

func NewPolicyUserNameTemplate added in v2.10.1 

func NewPolicyUserNameTemplate() *PolicyUserNameTemplate

func (*PolicyUserNameTemplate) IsPolicyInstance added in v2.10.1 

func (a *PolicyUserNameTemplate) IsPolicyInstance() bool

type PossessionConstraint added in v2.9.1 

type PossessionConstraint struct {
	Methods            []string `json:"methods,omitempty"`
	ReauthenticateIn   string   `json:"reauthenticateIn,omitempty"`
	Types              []string `json:"types,omitempty"`
	DeviceBound        string   `json:"deviceBound,omitempty"`
	HardwareProtection string   `json:"hardwareProtection,omitempty"`
	PhishingResistant  string   `json:"phishingResistant,omitempty"`
	UserPresence       string   `json:"userPresence,omitempty"`
}

func NewPossessionConstraint added in v2.10.1 

func NewPossessionConstraint() *PossessionConstraint

func (*PossessionConstraint) IsPolicyInstance added in v2.10.1 

func (a *PossessionConstraint) IsPolicyInstance() bool

type PreRegistrationInlineHook added in v2.9.1 

type PreRegistrationInlineHook struct {
	InlineHookId string `json:"inlineHookId,omitempty"`
}

func NewPreRegistrationInlineHook added in v2.10.1 

func NewPreRegistrationInlineHook() *PreRegistrationInlineHook

func (*PreRegistrationInlineHook) IsPolicyInstance added in v2.10.1 

func (a *PreRegistrationInlineHook) IsPolicyInstance() bool

type PrivateKeyAuth added in v2.17.0 

type PrivateKeyAuth struct {
	// contains filtered or unexported fields
}

func NewPrivateKeyAuth added in v2.17.0 

func NewPrivateKeyAuth(config PrivateKeyAuthConfig) *PrivateKeyAuth

func (*PrivateKeyAuth) Authorize added in v2.17.0 

func (a *PrivateKeyAuth) Authorize() error

type PrivateKeyAuthConfig added in v2.17.0 

type PrivateKeyAuthConfig struct {
	TokenCache       *goCache.Cache
	HttpClient       *http.Client
	PrivateKeySigner jose.Signer
	PrivateKey       string
	PrivateKeyId     string
	ClientId         string
	OrgURL           string
	Scopes           []string
	MaxRetries       int32
	MaxBackoff       int64
	Req              *http.Request
}

type ProfileEnrollmentPolicy added in v2.9.1 

type ProfileEnrollmentPolicy struct {
	Embedded    interface{}           `json:"_embedded,omitempty"`
	Links       interface{}           `json:"_links,omitempty"`
	Conditions  *PolicyRuleConditions `json:"conditions,omitempty"`
	Created     *time.Time            `json:"created,omitempty"`
	Description string                `json:"description,omitempty"`
	Id          string                `json:"id,omitempty"`
	LastUpdated *time.Time            `json:"lastUpdated,omitempty"`
	Name        string                `json:"name,omitempty"`
	Priority    int64                 `json:"-"`
	PriorityPtr *int64                `json:"priority,omitempty"`
	Status      string                `json:"status,omitempty"`
	System      *bool                 `json:"system,omitempty"`
	Type        string                `json:"type,omitempty"`
}

func NewProfileEnrollmentPolicy added in v2.10.1 

func NewProfileEnrollmentPolicy() *ProfileEnrollmentPolicy

func (*ProfileEnrollmentPolicy) IsPolicyInstance added in v2.10.1 

func (a *ProfileEnrollmentPolicy) IsPolicyInstance() bool

func (*ProfileEnrollmentPolicy) MarshalJSON added in v2.17.0 

func (a *ProfileEnrollmentPolicy) MarshalJSON() ([]byte, error)

func (*ProfileEnrollmentPolicy) UnmarshalJSON added in v2.17.0 

func (a *ProfileEnrollmentPolicy) UnmarshalJSON(data []byte) error

type ProfileEnrollmentPolicyRule added in v2.9.1 

type ProfileEnrollmentPolicyRule struct {
	Actions     *ProfileEnrollmentPolicyRuleActions `json:"actions,omitempty"`
	Conditions  *PolicyRuleConditions               `json:"conditions,omitempty"`
	Created     *time.Time                          `json:"created,omitempty"`
	Id          string                              `json:"id,omitempty"`
	LastUpdated *time.Time                          `json:"lastUpdated,omitempty"`
	Name        string                              `json:"name,omitempty"`
	Priority    int64                               `json:"-"`
	PriorityPtr *int64                              `json:"priority,omitempty"`
	Status      string                              `json:"status,omitempty"`
	System      *bool                               `json:"system,omitempty"`
	Type        string                              `json:"type,omitempty"`
}

func NewProfileEnrollmentPolicyRule added in v2.10.1 

func NewProfileEnrollmentPolicyRule() *ProfileEnrollmentPolicyRule

func (*ProfileEnrollmentPolicyRule) IsPolicyInstance added in v2.10.1 

func (a *ProfileEnrollmentPolicyRule) IsPolicyInstance() bool

func (*ProfileEnrollmentPolicyRule) MarshalJSON added in v2.17.0 

func (a *ProfileEnrollmentPolicyRule) MarshalJSON() ([]byte, error)

func (*ProfileEnrollmentPolicyRule) UnmarshalJSON added in v2.17.0 

func (a *ProfileEnrollmentPolicyRule) UnmarshalJSON(data []byte) error

type ProfileEnrollmentPolicyRuleAction added in v2.9.1 

type ProfileEnrollmentPolicyRuleAction struct {
	Access                     string                                            `json:"access,omitempty"`
	ActivationRequirements     *ProfileEnrollmentPolicyRuleActivationRequirement `json:"activationRequirements,omitempty"`
	PreRegistrationInlineHooks []*PreRegistrationInlineHook                      `json:"preRegistrationInlineHooks,omitempty"`
	ProfileAttributes          []*ProfileEnrollmentPolicyRuleProfileAttribute    `json:"profileAttributes,omitempty"`
	TargetGroupIds             []string                                          `json:"targetGroupIds,omitempty"`
	UiSchemaId                 string                                            `json:"uiSchemaId,omitempty"`
	UnknownUserAction          string                                            `json:"unknownUserAction,omitempty"`
}

func NewProfileEnrollmentPolicyRuleAction added in v2.10.1 

func NewProfileEnrollmentPolicyRuleAction() *ProfileEnrollmentPolicyRuleAction

func (*ProfileEnrollmentPolicyRuleAction) IsPolicyInstance added in v2.10.1 

func (a *ProfileEnrollmentPolicyRuleAction) IsPolicyInstance() bool

type ProfileEnrollmentPolicyRuleActions added in v2.9.1 

type ProfileEnrollmentPolicyRuleActions struct {
	Enroll                   *PolicyRuleActionsEnroll           `json:"enroll,omitempty"`
	Idp                      *IdpPolicyRuleAction               `json:"idp,omitempty"`
	PasswordChange           *PasswordPolicyRuleAction          `json:"passwordChange,omitempty"`
	SelfServicePasswordReset *PasswordPolicyRuleAction          `json:"selfServicePasswordReset,omitempty"`
	SelfServiceUnlock        *PasswordPolicyRuleAction          `json:"selfServiceUnlock,omitempty"`
	Signon                   *OktaSignOnPolicyRuleSignonActions `json:"signon,omitempty"`
	ProfileEnrollment        *ProfileEnrollmentPolicyRuleAction `json:"profileEnrollment,omitempty"`
}

func NewProfileEnrollmentPolicyRuleActions added in v2.10.1 

func NewProfileEnrollmentPolicyRuleActions() *ProfileEnrollmentPolicyRuleActions

func (*ProfileEnrollmentPolicyRuleActions) IsPolicyInstance added in v2.10.1 

func (a *ProfileEnrollmentPolicyRuleActions) IsPolicyInstance() bool

type ProfileEnrollmentPolicyRuleActivationRequirement added in v2.9.1 

type ProfileEnrollmentPolicyRuleActivationRequirement struct {
	EmailVerification *bool `json:"emailVerification,omitempty"`
}

func NewProfileEnrollmentPolicyRuleActivationRequirement added in v2.10.1 

func NewProfileEnrollmentPolicyRuleActivationRequirement() *ProfileEnrollmentPolicyRuleActivationRequirement

func (*ProfileEnrollmentPolicyRuleActivationRequirement) IsPolicyInstance added in v2.10.1 

func (a *ProfileEnrollmentPolicyRuleActivationRequirement) IsPolicyInstance() bool

type ProfileEnrollmentPolicyRuleProfileAttribute added in v2.9.1 

type ProfileEnrollmentPolicyRuleProfileAttribute struct {
	Label    string `json:"label,omitempty"`
	Name     string `json:"name,omitempty"`
	Required *bool  `json:"required,omitempty"`
}

func NewProfileEnrollmentPolicyRuleProfileAttribute added in v2.10.1 

func NewProfileEnrollmentPolicyRuleProfileAttribute() *ProfileEnrollmentPolicyRuleProfileAttribute

func (*ProfileEnrollmentPolicyRuleProfileAttribute) IsPolicyInstance added in v2.10.1 

func (a *ProfileEnrollmentPolicyRuleProfileAttribute) IsPolicyInstance() bool

type ProfileMapping added in v2.5.2 

type ProfileMapping struct {
	Links      interface{}                        `json:"_links,omitempty"`
	Id         string                             `json:"id,omitempty"`
	Properties map[string]*ProfileMappingProperty `json:"properties,omitempty"`
	Source     *ProfileMappingSource              `json:"source,omitempty"`
	Target     *ProfileMappingSource              `json:"target,omitempty"`
}

type ProfileMappingProperty added in v2.5.2 

type ProfileMappingProperty struct {
	Expression string `json:"expression,omitempty"`
	PushStatus string `json:"pushStatus,omitempty"`
}

type ProfileMappingPropertyPushStatus added in v2.5.2 

type ProfileMappingPropertyPushStatus string

type ProfileMappingResource added in v2.5.2 

type ProfileMappingResource resource

func (*ProfileMappingResource) GetProfileMapping added in v2.5.2 

func (m *ProfileMappingResource) GetProfileMapping(ctx context.Context, mappingId string) (*ProfileMapping, *Response, error)

Fetches a single Profile Mapping referenced by its ID.

func (*ProfileMappingResource) ListProfileMappings added in v2.5.2 

func (m *ProfileMappingResource) ListProfileMappings(ctx context.Context, qp *query.Params) ([]*ProfileMapping, *Response, error)

Enumerates Profile Mappings in your organization with pagination.

func (*ProfileMappingResource) UpdateProfileMapping added in v2.5.2 

func (m *ProfileMappingResource) UpdateProfileMapping(ctx context.Context, mappingId string, body ProfileMapping) (*ProfileMapping, *Response, error)

Updates an existing Profile Mapping by adding, updating, or removing one or many Property Mappings.

type ProfileMappingSource added in v2.5.2 

type ProfileMappingSource struct {
	Links interface{} `json:"_links,omitempty"`
	Id    string      `json:"id,omitempty"`
	Name  string      `json:"name,omitempty"`
	Type  string      `json:"type,omitempty"`
}

type ProfileSettingObject added in v2.10.0 

type ProfileSettingObject struct {
	Status string `json:"status,omitempty"`
}

func NewProfileSettingObject added in v2.10.0 

func NewProfileSettingObject() *ProfileSettingObject

func (*ProfileSettingObject) IsApplicationInstance added in v2.10.0 

func (a *ProfileSettingObject) IsApplicationInstance() bool

type Protocol 

type Protocol struct {
	Algorithms  *ProtocolAlgorithms          `json:"algorithms,omitempty"`
	Credentials *IdentityProviderCredentials `json:"credentials,omitempty"`
	Endpoints   *ProtocolEndpoints           `json:"endpoints,omitempty"`
	Issuer      *ProtocolEndpoint            `json:"issuer,omitempty"`
	RelayState  *ProtocolRelayState          `json:"relayState,omitempty"`
	Scopes      []string                     `json:"scopes,omitempty"`
	Settings    *ProtocolSettings            `json:"settings,omitempty"`
	Type        string                       `json:"type,omitempty"`
}

type ProtocolAlgorithmType 

type ProtocolAlgorithmType struct {
	Signature *ProtocolAlgorithmTypeSignature `json:"signature,omitempty"`
}

type ProtocolAlgorithmTypeSignature 

type ProtocolAlgorithmTypeSignature struct {
	Algorithm string `json:"algorithm,omitempty"`
	Scope     string `json:"scope,omitempty"`
}

type ProtocolAlgorithms 

type ProtocolAlgorithms struct {
	Request  *ProtocolAlgorithmType `json:"request,omitempty"`
	Response *ProtocolAlgorithmType `json:"response,omitempty"`
}

type ProtocolEndpoint 

type ProtocolEndpoint struct {
	Binding     string `json:"binding,omitempty"`
	Destination string `json:"destination,omitempty"`
	Type        string `json:"type,omitempty"`
	Url         string `json:"url,omitempty"`
}

type ProtocolEndpoints 

type ProtocolEndpoints struct {
	Acs           *ProtocolEndpoint `json:"acs,omitempty"`
	Authorization *ProtocolEndpoint `json:"authorization,omitempty"`
	Jwks          *ProtocolEndpoint `json:"jwks,omitempty"`
	Metadata      *ProtocolEndpoint `json:"metadata,omitempty"`
	Slo           *ProtocolEndpoint `json:"slo,omitempty"`
	Sso           *ProtocolEndpoint `json:"sso,omitempty"`
	Token         *ProtocolEndpoint `json:"token,omitempty"`
	UserInfo      *ProtocolEndpoint `json:"userInfo,omitempty"`
}

type ProtocolRelayState 

type ProtocolRelayState struct {
	Format string `json:"format,omitempty"`
}

type ProtocolRelayStateFormat 

type ProtocolRelayStateFormat string

type ProtocolSettings 

type ProtocolSettings struct {
	NameFormat string `json:"nameFormat,omitempty"`
}

type Provisioning 

type Provisioning struct {
	Action        string                  `json:"action,omitempty"`
	Conditions    *ProvisioningConditions `json:"conditions,omitempty"`
	Groups        *ProvisioningGroups     `json:"groups,omitempty"`
	ProfileMaster *bool                   `json:"profileMaster,omitempty"`
}

type ProvisioningConditions 

type ProvisioningConditions struct {
	Deprovisioned *ProvisioningDeprovisionedCondition `json:"deprovisioned,omitempty"`
	Suspended     *ProvisioningSuspendedCondition     `json:"suspended,omitempty"`
}

type ProvisioningConnection added in v2.10.0 

type ProvisioningConnection struct {
	Links      interface{} `json:"_links,omitempty"`
	AuthScheme string      `json:"authScheme,omitempty"`
	Status     string      `json:"status,omitempty"`
}

func NewProvisioningConnection added in v2.10.0 

func NewProvisioningConnection() *ProvisioningConnection

func (*ProvisioningConnection) IsApplicationInstance added in v2.10.0 

func (a *ProvisioningConnection) IsApplicationInstance() bool

type ProvisioningConnectionAuthScheme added in v2.10.0 

type ProvisioningConnectionAuthScheme string

type ProvisioningConnectionProfile added in v2.10.0 

type ProvisioningConnectionProfile struct {
	AuthScheme string `json:"authScheme,omitempty"`
	Token      string `json:"token,omitempty"`
}

func NewProvisioningConnectionProfile added in v2.10.0 

func NewProvisioningConnectionProfile() *ProvisioningConnectionProfile

func (*ProvisioningConnectionProfile) IsApplicationInstance added in v2.10.0 

func (a *ProvisioningConnectionProfile) IsApplicationInstance() bool

type ProvisioningConnectionProfileResource added in v2.10.0 

type ProvisioningConnectionProfileResource resource

type ProvisioningConnectionRequest added in v2.10.0 

type ProvisioningConnectionRequest struct {
	Profile *ProvisioningConnectionProfile `json:"profile,omitempty"`
}

func NewProvisioningConnectionRequest added in v2.10.0 

func NewProvisioningConnectionRequest() *ProvisioningConnectionRequest

func (*ProvisioningConnectionRequest) IsApplicationInstance added in v2.10.0 

func (a *ProvisioningConnectionRequest) IsApplicationInstance() bool

type ProvisioningConnectionResource added in v2.10.0 

type ProvisioningConnectionResource resource

type ProvisioningConnectionStatus added in v2.10.0 

type ProvisioningConnectionStatus string

type ProvisioningDeprovisionedCondition 

type ProvisioningDeprovisionedCondition struct {
	Action string `json:"action,omitempty"`
}

type ProvisioningGroups 

type ProvisioningGroups struct {
	Action              string   `json:"action,omitempty"`
	Assignments         []string `json:"assignments,omitempty"`
	Filter              []string `json:"filter,omitempty"`
	SourceAttributeName string   `json:"sourceAttributeName,omitempty"`
}

type ProvisioningSuspendedCondition 

type ProvisioningSuspendedCondition struct {
	Action string `json:"action,omitempty"`
}

type PushUserFactor 

type PushUserFactor struct {
	Embedded     interface{}            `json:"_embedded,omitempty"`
	Links        interface{}            `json:"_links,omitempty"`
	Created      *time.Time             `json:"created,omitempty"`
	FactorType   string                 `json:"factorType,omitempty"`
	Id           string                 `json:"id,omitempty"`
	LastUpdated  *time.Time             `json:"lastUpdated,omitempty"`
	Provider     string                 `json:"provider,omitempty"`
	Status       string                 `json:"status,omitempty"`
	Verify       *VerifyFactorRequest   `json:"verify,omitempty"`
	ExpiresAt    *time.Time             `json:"expiresAt,omitempty"`
	FactorResult string                 `json:"factorResult,omitempty"`
	Profile      *PushUserFactorProfile `json:"profile,omitempty"`
}

func NewPushUserFactor 

func NewPushUserFactor() *PushUserFactor

func (*PushUserFactor) IsUserFactorInstance 

func (a *PushUserFactor) IsUserFactorInstance() bool

type PushUserFactorProfile 

type PushUserFactorProfile struct {
	CredentialId string `json:"credentialId,omitempty"`
	DeviceToken  string `json:"deviceToken,omitempty"`
	DeviceType   string `json:"deviceType,omitempty"`
	Name         string `json:"name,omitempty"`
	Platform     string `json:"platform,omitempty"`
	Version      string `json:"version,omitempty"`
}

func NewPushUserFactorProfile 

func NewPushUserFactorProfile() *PushUserFactorProfile

func (*PushUserFactorProfile) IsUserFactorInstance 

func (a *PushUserFactorProfile) IsUserFactorInstance() bool

type RecoveryQuestionCredential 

type RecoveryQuestionCredential struct {
	Answer   string `json:"answer,omitempty"`
	Question string `json:"question,omitempty"`
}

type RequestAccessToken 

type RequestAccessToken struct {
	TokenType   string `json:"token_type,omitempty"`
	ExpiresIn   int    `json:"expires_in,omitempty"`
	AccessToken string `json:"access_token,omitempty"`
	Scope       string `json:"scope,omitempty"`
}

type RequestExecutor 

type RequestExecutor struct {
	BaseUrl *urlpkg.URL
	// contains filtered or unexported fields
}

func NewRequestExecutor 

func NewRequestExecutor(httpClient *http.Client, cache cache.Cache, config *config) *RequestExecutor

func (*RequestExecutor) AsBinary 

func (re *RequestExecutor) AsBinary() *RequestExecutor

func (*RequestExecutor) Do 

func (re *RequestExecutor) Do(ctx context.Context, req *http.Request, v interface{}) (*Response, error)

func (*RequestExecutor) NewRequest 

func (re *RequestExecutor) NewRequest(method string, url string, body interface{}) (*http.Request, error)

func (*RequestExecutor) RefreshNext 

func (re *RequestExecutor) RefreshNext() *RequestExecutor

func (*RequestExecutor) WithAccept 

func (re *RequestExecutor) WithAccept(acceptHeader string) *RequestExecutor

func (*RequestExecutor) WithContentType 

func (re *RequestExecutor) WithContentType(contentTypeHeader string) *RequestExecutor

type RequiredEnum added in v2.9.1 

type RequiredEnum string

type ResetPasswordToken 

type ResetPasswordToken struct {
	ResetPasswordUrl string `json:"resetPasswordUrl,omitempty"`
}

type Response 

type Response struct {
	*http.Response

	Self     string
	NextPage string
	// contains filtered or unexported fields
}

func (*Response) HasNextPage 

func (r *Response) HasNextPage() bool

func (*Response) Next 

func (r *Response) Next(ctx context.Context, v interface{}) (*Response, error)
type ResponseLinks struct {
	Links interface{} `json:"_links,omitempty"`
}

type RiskPolicyRuleCondition 

type RiskPolicyRuleCondition struct {
	Behaviors []string `json:"behaviors,omitempty"`
}

func NewRiskPolicyRuleCondition added in v2.10.1 

func NewRiskPolicyRuleCondition() *RiskPolicyRuleCondition

func (*RiskPolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *RiskPolicyRuleCondition) IsPolicyInstance() bool

type RiskScorePolicyRuleCondition 

type RiskScorePolicyRuleCondition struct {
	Level string `json:"level,omitempty"`
}

func NewRiskScorePolicyRuleCondition added in v2.10.1 

func NewRiskScorePolicyRuleCondition() *RiskScorePolicyRuleCondition

func (*RiskScorePolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *RiskScorePolicyRuleCondition) IsPolicyInstance() bool

type Role 

type Role struct {
	Embedded       interface{} `json:"_embedded,omitempty"`
	Links          interface{} `json:"_links,omitempty"`
	AssignmentType string      `json:"assignmentType,omitempty"`
	Created        *time.Time  `json:"created,omitempty"`
	Description    string      `json:"description,omitempty"`
	Id             string      `json:"id,omitempty"`
	Label          string      `json:"label,omitempty"`
	LastUpdated    *time.Time  `json:"lastUpdated,omitempty"`
	Status         string      `json:"status,omitempty"`
	Type           string      `json:"type,omitempty"`
}

type RoleAssignmentType 

type RoleAssignmentType string

type RoleStatus 

type RoleStatus string

type RoleType 

type RoleType string

type SSWSAuth added in v2.17.0 

type SSWSAuth struct {
	// contains filtered or unexported fields
}

func NewSSWSAuth added in v2.17.0 

func NewSSWSAuth(token string, req *http.Request) *SSWSAuth

func (*SSWSAuth) Authorize added in v2.17.0 

func (a *SSWSAuth) Authorize() error

type SamlApplication 

type SamlApplication struct {
	Embedded      interface{}               `json:"_embedded,omitempty"`
	Links         interface{}               `json:"_links,omitempty"`
	Accessibility *ApplicationAccessibility `json:"accessibility,omitempty"`
	Created       *time.Time                `json:"created,omitempty"`
	Credentials   *ApplicationCredentials   `json:"credentials,omitempty"`
	Features      []string                  `json:"features,omitempty"`
	Id            string                    `json:"id,omitempty"`
	Label         string                    `json:"label,omitempty"`
	LastUpdated   *time.Time                `json:"lastUpdated,omitempty"`
	Licensing     *ApplicationLicensing     `json:"licensing,omitempty"`
	Name          string                    `json:"name,omitempty"`
	Profile       interface{}               `json:"profile,omitempty"`
	Settings      *SamlApplicationSettings  `json:"settings,omitempty"`
	SignOnMode    string                    `json:"signOnMode,omitempty"`
	Status        string                    `json:"status,omitempty"`
	Visibility    *ApplicationVisibility    `json:"visibility,omitempty"`
}

func NewSamlApplication 

func NewSamlApplication() *SamlApplication

func (*SamlApplication) IsApplicationInstance 

func (a *SamlApplication) IsApplicationInstance() bool

type SamlApplicationSettings 

type SamlApplicationSettings struct {
	App                *ApplicationSettingsApplication   `json:"app,omitempty"`
	ImplicitAssignment *bool                             `json:"implicitAssignment,omitempty"`
	InlineHookId       string                            `json:"inlineHookId,omitempty"`
	Notes              *ApplicationSettingsNotes         `json:"notes,omitempty"`
	Notifications      *ApplicationSettingsNotifications `json:"notifications,omitempty"`
	SignOn             *SamlApplicationSettingsSignOn    `json:"signOn,omitempty"`
}

type SamlApplicationSettingsSignOn 

type SamlApplicationSettingsSignOn struct {
	AcsEndpoints              []*AcsEndpoint            `json:"acsEndpoints,omitempty"`
	AllowMultipleAcsEndpoints *bool                     `json:"allowMultipleAcsEndpoints,omitempty"`
	AssertionSigned           *bool                     `json:"assertionSigned,omitempty"`
	AttributeStatements       []*SamlAttributeStatement `json:"attributeStatements"`
	Audience                  string                    `json:"audience,omitempty"`
	AudienceOverride          string                    `json:"audienceOverride"`
	AuthnContextClassRef      string                    `json:"authnContextClassRef,omitempty"`
	DefaultRelayState         string                    `json:"defaultRelayState"`
	Destination               string                    `json:"destination,omitempty"`
	DestinationOverride       string                    `json:"destinationOverride"`
	DigestAlgorithm           string                    `json:"digestAlgorithm,omitempty"`
	HonorForceAuthn           *bool                     `json:"honorForceAuthn,omitempty"`
	IdpIssuer                 string                    `json:"idpIssuer,omitempty"`
	InlineHooks               []*SignOnInlineHook       `json:"inlineHooks,omitempty"`
	Recipient                 string                    `json:"recipient,omitempty"`
	RecipientOverride         string                    `json:"recipientOverride"`
	RequestCompressed         *bool                     `json:"requestCompressed,omitempty"`
	ResponseSigned            *bool                     `json:"responseSigned,omitempty"`
	SamlSignedRequestEnabled  *bool                     `json:"samlSignedRequestEnabled,omitempty"`
	SignatureAlgorithm        string                    `json:"signatureAlgorithm,omitempty"`
	Slo                       *SingleLogout             `json:"slo,omitempty"`
	SpCertificate             *SpCertificate            `json:"spCertificate,omitempty"`
	SpIssuer                  string                    `json:"spIssuer,omitempty"`
	SsoAcsUrl                 string                    `json:"ssoAcsUrl,omitempty"`
	SsoAcsUrlOverride         string                    `json:"ssoAcsUrlOverride"`
	SubjectNameIdFormat       string                    `json:"subjectNameIdFormat,omitempty"`
	SubjectNameIdTemplate     string                    `json:"subjectNameIdTemplate,omitempty"`
}

type SamlAttributeStatement 

type SamlAttributeStatement struct {
	FilterType  string   `json:"filterType,omitempty"`
	FilterValue string   `json:"filterValue,omitempty"`
	Name        string   `json:"name,omitempty"`
	Namespace   string   `json:"namespace,omitempty"`
	Type        string   `json:"type,omitempty"`
	Values      []string `json:"values,omitempty"`
}

type ScheduledUserLifecycleAction 

type ScheduledUserLifecycleAction struct {
	Status string `json:"status,omitempty"`
}

func NewScheduledUserLifecycleAction added in v2.10.1 

func NewScheduledUserLifecycleAction() *ScheduledUserLifecycleAction

func (*ScheduledUserLifecycleAction) IsPolicyInstance added in v2.10.1 

func (a *ScheduledUserLifecycleAction) IsPolicyInstance() bool

type SchemeApplicationCredentials 

type SchemeApplicationCredentials struct {
	Signing          *ApplicationCredentialsSigning          `json:"signing,omitempty"`
	UserNameTemplate *ApplicationCredentialsUsernameTemplate `json:"userNameTemplate,omitempty"`
	Password         *PasswordCredential                     `json:"password,omitempty"`
	RevealPassword   *bool                                   `json:"revealPassword,omitempty"`
	Scheme           string                                  `json:"scheme,omitempty"`
	UserName         string                                  `json:"userName"`
}

type Scope 

type Scope struct {
	AllowedOktaApps []*IframeEmbedScopeAllowedApps `json:"allowedOktaApps,omitempty"`
	StringValue     string                         `json:"stringValue,omitempty"`
	Type            string                         `json:"type,omitempty"`
}

type ScopeType 

type ScopeType string

type SecurePasswordStoreApplication 

type SecurePasswordStoreApplication struct {
	Embedded      interface{}                             `json:"_embedded,omitempty"`
	Links         interface{}                             `json:"_links,omitempty"`
	Accessibility *ApplicationAccessibility               `json:"accessibility,omitempty"`
	Created       *time.Time                              `json:"created,omitempty"`
	Credentials   *SchemeApplicationCredentials           `json:"credentials,omitempty"`
	Features      []string                                `json:"features,omitempty"`
	Id            string                                  `json:"id,omitempty"`
	Label         string                                  `json:"label,omitempty"`
	LastUpdated   *time.Time                              `json:"lastUpdated,omitempty"`
	Licensing     *ApplicationLicensing                   `json:"licensing,omitempty"`
	Name          string                                  `json:"name,omitempty"`
	Profile       interface{}                             `json:"profile,omitempty"`
	Settings      *SecurePasswordStoreApplicationSettings `json:"settings,omitempty"`
	SignOnMode    string                                  `json:"signOnMode,omitempty"`
	Status        string                                  `json:"status,omitempty"`
	Visibility    *ApplicationVisibility                  `json:"visibility,omitempty"`
}

func NewSecurePasswordStoreApplication 

func NewSecurePasswordStoreApplication() *SecurePasswordStoreApplication

func (*SecurePasswordStoreApplication) IsApplicationInstance 

func (a *SecurePasswordStoreApplication) IsApplicationInstance() bool

type SecurePasswordStoreApplicationSettings 

type SecurePasswordStoreApplicationSettings struct {
	App                *SecurePasswordStoreApplicationSettingsApplication `json:"app,omitempty"`
	ImplicitAssignment *bool                                              `json:"implicitAssignment,omitempty"`
	InlineHookId       string                                             `json:"inlineHookId,omitempty"`
	Notes              *ApplicationSettingsNotes                          `json:"notes,omitempty"`
	Notifications      *ApplicationSettingsNotifications                  `json:"notifications,omitempty"`
}

type SecurePasswordStoreApplicationSettingsApplication 

type SecurePasswordStoreApplicationSettingsApplication struct {
	OptionalField1      string `json:"optionalField1,omitempty"`
	OptionalField1Value string `json:"optionalField1Value,omitempty"`
	OptionalField2      string `json:"optionalField2,omitempty"`
	OptionalField2Value string `json:"optionalField2Value,omitempty"`
	OptionalField3      string `json:"optionalField3,omitempty"`
	OptionalField3Value string `json:"optionalField3Value,omitempty"`
	PasswordField       string `json:"passwordField,omitempty"`
	Url                 string `json:"url,omitempty"`
	UsernameField       string `json:"usernameField,omitempty"`
}

type SecurityQuestion 

type SecurityQuestion struct {
	Answer       string `json:"answer,omitempty"`
	Question     string `json:"question,omitempty"`
	QuestionText string `json:"questionText,omitempty"`
}

func NewSecurityQuestion 

func NewSecurityQuestion() *SecurityQuestion

func (*SecurityQuestion) IsUserFactorInstance 

func (a *SecurityQuestion) IsUserFactorInstance() bool

type SecurityQuestionUserFactor 

type SecurityQuestionUserFactor struct {
	Embedded    interface{}                        `json:"_embedded,omitempty"`
	Links       interface{}                        `json:"_links,omitempty"`
	Created     *time.Time                         `json:"created,omitempty"`
	FactorType  string                             `json:"factorType,omitempty"`
	Id          string                             `json:"id,omitempty"`
	LastUpdated *time.Time                         `json:"lastUpdated,omitempty"`
	Provider    string                             `json:"provider,omitempty"`
	Status      string                             `json:"status,omitempty"`
	Verify      *VerifyFactorRequest               `json:"verify,omitempty"`
	Profile     *SecurityQuestionUserFactorProfile `json:"profile,omitempty"`
}

func NewSecurityQuestionUserFactor 

func NewSecurityQuestionUserFactor() *SecurityQuestionUserFactor

func (*SecurityQuestionUserFactor) IsUserFactorInstance 

func (a *SecurityQuestionUserFactor) IsUserFactorInstance() bool

type SecurityQuestionUserFactorProfile 

type SecurityQuestionUserFactorProfile struct {
	Answer       string `json:"answer,omitempty"`
	Question     string `json:"question,omitempty"`
	QuestionText string `json:"questionText,omitempty"`
}

func NewSecurityQuestionUserFactorProfile 

func NewSecurityQuestionUserFactorProfile() *SecurityQuestionUserFactorProfile

func (*SecurityQuestionUserFactorProfile) IsUserFactorInstance 

func (a *SecurityQuestionUserFactorProfile) IsUserFactorInstance() bool

type SeedEnum added in v2.10.0 

type SeedEnum string

type Session 

type Session struct {
	Links                    interface{}                    `json:"_links,omitempty"`
	Amr                      []*SessionAuthenticationMethod `json:"amr,omitempty"`
	CreatedAt                *time.Time                     `json:"createdAt,omitempty"`
	ExpiresAt                *time.Time                     `json:"expiresAt,omitempty"`
	Id                       string                         `json:"id,omitempty"`
	Idp                      *SessionIdentityProvider       `json:"idp,omitempty"`
	LastFactorVerification   *time.Time                     `json:"lastFactorVerification,omitempty"`
	LastPasswordVerification *time.Time                     `json:"lastPasswordVerification,omitempty"`
	Login                    string                         `json:"login,omitempty"`
	Status                   string                         `json:"status,omitempty"`
	UserId                   string                         `json:"userId,omitempty"`
}

type SessionAuthenticationMethod 

type SessionAuthenticationMethod string

type SessionIdentityProvider 

type SessionIdentityProvider struct {
	Id   string `json:"id,omitempty"`
	Type string `json:"type,omitempty"`
}

type SessionIdentityProviderType 

type SessionIdentityProviderType string

type SessionResource 

type SessionResource resource

func (*SessionResource) CreateSession 

func (m *SessionResource) CreateSession(ctx context.Context, body CreateSessionRequest) (*Session, *Response, error)

Creates a new session for a user with a valid session token. Use this API if, for example, you want to set the session cookie yourself instead of allowing Okta to set it, or want to hold the session ID in order to delete a session via the API instead of visiting the logout URL.

func (*SessionResource) EndSession 

func (m *SessionResource) EndSession(ctx context.Context, sessionId string) (*Response, error)

func (*SessionResource) GetSession 

func (m *SessionResource) GetSession(ctx context.Context, sessionId string) (*Session, *Response, error)

Get details about a session.

func (*SessionResource) RefreshSession 

func (m *SessionResource) RefreshSession(ctx context.Context, sessionId string) (*Session, *Response, error)

type SessionStatus 

type SessionStatus string

type SignInPageTouchPointVariant added in v2.9.1 

type SignInPageTouchPointVariant string

type SignOnInlineHook added in v2.5.2 

type SignOnInlineHook struct {
	Id string `json:"id,omitempty"`
}

type SingleLogout added in v2.3.0 

type SingleLogout struct {
	Enabled   *bool  `json:"enabled,omitempty"`
	Issuer    string `json:"issuer,omitempty"`
	LogoutUrl string `json:"logoutUrl,omitempty"`
}

type SmsTemplate 

type SmsTemplate struct {
	Created      *time.Time               `json:"created,omitempty"`
	Id           string                   `json:"id,omitempty"`
	LastUpdated  *time.Time               `json:"lastUpdated,omitempty"`
	Name         string                   `json:"name,omitempty"`
	Template     string                   `json:"template,omitempty"`
	Translations *SmsTemplateTranslations `json:"translations,omitempty"`
	Type         string                   `json:"type,omitempty"`
}

type SmsTemplateResource 

type SmsTemplateResource resource

func (*SmsTemplateResource) CreateSmsTemplate 

func (m *SmsTemplateResource) CreateSmsTemplate(ctx context.Context, body SmsTemplate) (*SmsTemplate, *Response, error)

Adds a new custom SMS template to your organization.

func (*SmsTemplateResource) DeleteSmsTemplate 

func (m *SmsTemplateResource) DeleteSmsTemplate(ctx context.Context, templateId string) (*Response, error)

Removes an SMS template.

func (*SmsTemplateResource) GetSmsTemplate 

func (m *SmsTemplateResource) GetSmsTemplate(ctx context.Context, templateId string) (*SmsTemplate, *Response, error)

Fetches a specific template by `id`

func (*SmsTemplateResource) ListSmsTemplates 

func (m *SmsTemplateResource) ListSmsTemplates(ctx context.Context, qp *query.Params) ([]*SmsTemplate, *Response, error)

Enumerates custom SMS templates in your organization. A subset of templates can be returned that match a template type.

func (*SmsTemplateResource) PartialUpdateSmsTemplate 

func (m *SmsTemplateResource) PartialUpdateSmsTemplate(ctx context.Context, templateId string, body SmsTemplate) (*SmsTemplate, *Response, error)

Updates only some of the SMS template properties:

func (*SmsTemplateResource) UpdateSmsTemplate 

func (m *SmsTemplateResource) UpdateSmsTemplate(ctx context.Context, templateId string, body SmsTemplate) (*SmsTemplate, *Response, error)

Updates the SMS template.

type SmsTemplateTranslations 

type SmsTemplateTranslations map[string]interface{}

type SmsTemplateType 

type SmsTemplateType string

type SmsUserFactor 

type SmsUserFactor struct {
	Embedded    interface{}           `json:"_embedded,omitempty"`
	Links       interface{}           `json:"_links,omitempty"`
	Created     *time.Time            `json:"created,omitempty"`
	FactorType  string                `json:"factorType,omitempty"`
	Id          string                `json:"id,omitempty"`
	LastUpdated *time.Time            `json:"lastUpdated,omitempty"`
	Provider    string                `json:"provider,omitempty"`
	Status      string                `json:"status,omitempty"`
	Verify      *VerifyFactorRequest  `json:"verify,omitempty"`
	Profile     *SmsUserFactorProfile `json:"profile,omitempty"`
}

func NewSmsUserFactor 

func NewSmsUserFactor() *SmsUserFactor

func (*SmsUserFactor) IsUserFactorInstance 

func (a *SmsUserFactor) IsUserFactorInstance() bool

type SmsUserFactorProfile 

type SmsUserFactorProfile struct {
	PhoneNumber string `json:"phoneNumber,omitempty"`
}

func NewSmsUserFactorProfile 

func NewSmsUserFactorProfile() *SmsUserFactorProfile

func (*SmsUserFactorProfile) IsUserFactorInstance 

func (a *SmsUserFactorProfile) IsUserFactorInstance() bool

type SocialAuthToken 

type SocialAuthToken struct {
	ExpiresAt       *time.Time `json:"expiresAt,omitempty"`
	Id              string     `json:"id,omitempty"`
	Scopes          []string   `json:"scopes,omitempty"`
	Token           string     `json:"token,omitempty"`
	TokenAuthScheme string     `json:"tokenAuthScheme,omitempty"`
	TokenType       string     `json:"tokenType,omitempty"`
}

func (*SocialAuthToken) UnmarshalJSON added in v2.10.1 

func (a *SocialAuthToken) UnmarshalJSON(data []byte) error

type SpCertificate added in v2.3.0 

type SpCertificate struct {
	X5c []string `json:"x5c,omitempty"`
}

type Subscription added in v2.10.0 

type Subscription struct {
	Links            interface{} `json:"_links,omitempty"`
	Channels         []string    `json:"channels,omitempty"`
	NotificationType string      `json:"notificationType,omitempty"`
	Status           string      `json:"status,omitempty"`
}

type SubscriptionResource added in v2.10.0 

type SubscriptionResource resource

func (*SubscriptionResource) GetRoleSubscriptionByNotificationType added in v2.10.0 

func (m *SubscriptionResource) GetRoleSubscriptionByNotificationType(ctx context.Context, roleTypeOrRoleId string, notificationType string) (*Subscription, *Response, error)

When roleType Get subscriptions of a Role with a specific notification type. Else when roleId Get subscription of a Custom Role with a specific notification type.

func (*SubscriptionResource) ListRoleSubscriptions added in v2.10.0 

func (m *SubscriptionResource) ListRoleSubscriptions(ctx context.Context, roleTypeOrRoleId string) ([]*Subscription, *Response, error)

When roleType List all subscriptions of a Role. Else when roleId List subscriptions of a Custom Role

func (*SubscriptionResource) SubscribeRoleSubscriptionByNotificationType added in v2.10.0 

func (m *SubscriptionResource) SubscribeRoleSubscriptionByNotificationType(ctx context.Context, roleTypeOrRoleId string, notificationType string) (*Response, error)

When roleType Subscribes a Role to a specific notification type. When you change the subscription status of a Role, it overrides the subscription of any individual user of that Role. Else when roleId Subscribes a Custom Role to a specific notification type. When you change the subscription status of a Custom Role, it overrides the subscription of any individual user of that Custom Role.

func (*SubscriptionResource) SubscribeUserSubscriptionByNotificationType added in v2.10.0 

func (m *SubscriptionResource) SubscribeUserSubscriptionByNotificationType(ctx context.Context, userId string, notificationType string) (*Response, error)

Subscribes a User to a specific notification type. Only the current User can subscribe to a specific notification type. An AccessDeniedException message is sent if requests are made from other users.

func (*SubscriptionResource) UnsubscribeRoleSubscriptionByNotificationType added in v2.10.0 

func (m *SubscriptionResource) UnsubscribeRoleSubscriptionByNotificationType(ctx context.Context, roleTypeOrRoleId string, notificationType string) (*Response, error)

When roleType Unsubscribes a Role from a specific notification type. When you change the subscription status of a Role, it overrides the subscription of any individual user of that Role. Else when roleId Unsubscribes a Custom Role from a specific notification type. When you change the subscription status of a Custom Role, it overrides the subscription of any individual user of that Custom Role.

func (*SubscriptionResource) UnsubscribeUserSubscriptionByNotificationType added in v2.10.0 

func (m *SubscriptionResource) UnsubscribeUserSubscriptionByNotificationType(ctx context.Context, userId string, notificationType string) (*Response, error)

Unsubscribes a User from a specific notification type. Only the current User can unsubscribe from a specific notification type. An AccessDeniedException message is sent if requests are made from other users.

type SubscriptionStatus added in v2.10.0 

type SubscriptionStatus string

type SwaApplication 

type SwaApplication struct {
	Credentials   *SchemeApplicationCredentials `json:"credentials,omitempty"`
	Embedded      interface{}                   `json:"_embedded,omitempty"`
	Links         interface{}                   `json:"_links,omitempty"`
	Accessibility *ApplicationAccessibility     `json:"accessibility,omitempty"`
	Created       *time.Time                    `json:"created,omitempty"`
	Features      []string                      `json:"features,omitempty"`
	Id            string                        `json:"id,omitempty"`
	Label         string                        `json:"label,omitempty"`
	LastUpdated   *time.Time                    `json:"lastUpdated,omitempty"`
	Licensing     *ApplicationLicensing         `json:"licensing,omitempty"`
	Name          string                        `json:"name,omitempty"`
	Profile       interface{}                   `json:"profile,omitempty"`
	Settings      *SwaApplicationSettings       `json:"settings,omitempty"`
	SignOnMode    string                        `json:"signOnMode,omitempty"`
	Status        string                        `json:"status,omitempty"`
	Visibility    *ApplicationVisibility        `json:"visibility,omitempty"`
}

func NewSwaApplication 

func NewSwaApplication() *SwaApplication

func (*SwaApplication) IsApplicationInstance 

func (a *SwaApplication) IsApplicationInstance() bool

type SwaApplicationSettings 

type SwaApplicationSettings struct {
	App                *SwaApplicationSettingsApplication `json:"app,omitempty"`
	ImplicitAssignment *bool                              `json:"implicitAssignment,omitempty"`
	InlineHookId       string                             `json:"inlineHookId,omitempty"`
	Notes              *ApplicationSettingsNotes          `json:"notes,omitempty"`
	Notifications      *ApplicationSettingsNotifications  `json:"notifications,omitempty"`
}

type SwaApplicationSettingsApplication 

type SwaApplicationSettingsApplication struct {
	ButtonField   string `json:"buttonField,omitempty"`
	Checkbox      string `json:"checkbox,omitempty"`
	LoginUrlRegex string `json:"loginUrlRegex,omitempty"`
	PasswordField string `json:"passwordField,omitempty"`
	RedirectUrl   string `json:"redirectUrl,omitempty"`
	Url           string `json:"url,omitempty"`
	UsernameField string `json:"usernameField,omitempty"`
}

type SwaThreeFieldApplication 

type SwaThreeFieldApplication struct {
	Credentials   *SchemeApplicationCredentials     `json:"credentials,omitempty"`
	Embedded      interface{}                       `json:"_embedded,omitempty"`
	Links         interface{}                       `json:"_links,omitempty"`
	Accessibility *ApplicationAccessibility         `json:"accessibility,omitempty"`
	Created       *time.Time                        `json:"created,omitempty"`
	Features      []string                          `json:"features,omitempty"`
	Id            string                            `json:"id,omitempty"`
	Label         string                            `json:"label,omitempty"`
	LastUpdated   *time.Time                        `json:"lastUpdated,omitempty"`
	Licensing     *ApplicationLicensing             `json:"licensing,omitempty"`
	Name          string                            `json:"name,omitempty"`
	Profile       interface{}                       `json:"profile,omitempty"`
	Settings      *SwaThreeFieldApplicationSettings `json:"settings,omitempty"`
	SignOnMode    string                            `json:"signOnMode,omitempty"`
	Status        string                            `json:"status,omitempty"`
	Visibility    *ApplicationVisibility            `json:"visibility,omitempty"`
}

func NewSwaThreeFieldApplication 

func NewSwaThreeFieldApplication() *SwaThreeFieldApplication

func (*SwaThreeFieldApplication) IsApplicationInstance 

func (a *SwaThreeFieldApplication) IsApplicationInstance() bool

type SwaThreeFieldApplicationSettings 

type SwaThreeFieldApplicationSettings struct {
	App                *SwaThreeFieldApplicationSettingsApplication `json:"app,omitempty"`
	ImplicitAssignment *bool                                        `json:"implicitAssignment,omitempty"`
	InlineHookId       string                                       `json:"inlineHookId,omitempty"`
	Notes              *ApplicationSettingsNotes                    `json:"notes,omitempty"`
	Notifications      *ApplicationSettingsNotifications            `json:"notifications,omitempty"`
}

type SwaThreeFieldApplicationSettingsApplication 

type SwaThreeFieldApplicationSettingsApplication struct {
	ButtonSelector     string `json:"buttonSelector,omitempty"`
	ExtraFieldSelector string `json:"extraFieldSelector,omitempty"`
	ExtraFieldValue    string `json:"extraFieldValue,omitempty"`
	LoginUrlRegex      string `json:"loginUrlRegex,omitempty"`
	PasswordSelector   string `json:"passwordSelector,omitempty"`
	TargetURL          string `json:"targetURL,omitempty"`
	UserNameSelector   string `json:"userNameSelector,omitempty"`
}

type TempPassword 

type TempPassword struct {
	TempPassword string `json:"tempPassword,omitempty"`
}

type Theme added in v2.9.1 

type Theme struct {
	Links                             interface{} `json:"_links,omitempty"`
	BackgroundImage                   string      `json:"backgroundImage,omitempty"`
	EmailTemplateTouchPointVariant    string      `json:"emailTemplateTouchPointVariant,omitempty"`
	EndUserDashboardTouchPointVariant string      `json:"endUserDashboardTouchPointVariant,omitempty"`
	ErrorPageTouchPointVariant        string      `json:"errorPageTouchPointVariant,omitempty"`
	PrimaryColorContrastHex           string      `json:"primaryColorContrastHex,omitempty"`
	PrimaryColorHex                   string      `json:"primaryColorHex,omitempty"`
	SecondaryColorContrastHex         string      `json:"secondaryColorContrastHex,omitempty"`
	SecondaryColorHex                 string      `json:"secondaryColorHex,omitempty"`
	SignInPageTouchPointVariant       string      `json:"signInPageTouchPointVariant,omitempty"`
}

type ThemeResource added in v2.9.1 

type ThemeResource resource

func (*ThemeResource) GetBrandTheme added in v2.9.1 

func (m *ThemeResource) GetBrandTheme(ctx context.Context, brandId string, themeId string) (*ThemeResponse, *Response, error)

Fetches a theme for a brand

func (*ThemeResource) UpdateBrandTheme added in v2.9.1 

func (m *ThemeResource) UpdateBrandTheme(ctx context.Context, brandId string, themeId string, body Theme) (*ThemeResponse, *Response, error)

Updates a theme for a brand

type ThemeResponse added in v2.9.1 

type ThemeResponse struct {
	Links                             interface{} `json:"_links,omitempty"`
	BackgroundImage                   string      `json:"backgroundImage,omitempty"`
	EmailTemplateTouchPointVariant    string      `json:"emailTemplateTouchPointVariant,omitempty"`
	EndUserDashboardTouchPointVariant string      `json:"endUserDashboardTouchPointVariant,omitempty"`
	ErrorPageTouchPointVariant        string      `json:"errorPageTouchPointVariant,omitempty"`
	Favicon                           string      `json:"favicon,omitempty"`
	Id                                string      `json:"id,omitempty"`
	PrimaryColorContrastHex           string      `json:"primaryColorContrastHex,omitempty"`
	PrimaryColorHex                   string      `json:"primaryColorHex,omitempty"`
	SecondaryColorContrastHex         string      `json:"secondaryColorContrastHex,omitempty"`
	SecondaryColorHex                 string      `json:"secondaryColorHex,omitempty"`
	SignInPageTouchPointVariant       string      `json:"signInPageTouchPointVariant,omitempty"`
}

type ThreatInsightConfiguration added in v2.5.2 

type ThreatInsightConfiguration struct {
	Links        interface{} `json:"_links,omitempty"`
	Action       string      `json:"action,omitempty"`
	Created      *time.Time  `json:"created,omitempty"`
	ExcludeZones []string    `json:"excludeZones,omitempty"`
	LastUpdated  *time.Time  `json:"lastUpdated,omitempty"`
}

type ThreatInsightConfigurationResource added in v2.5.2 

type ThreatInsightConfigurationResource resource

func (*ThreatInsightConfigurationResource) GetCurrentConfiguration added in v2.5.2 

func (m *ThreatInsightConfigurationResource) GetCurrentConfiguration(ctx context.Context) (*ThreatInsightConfiguration, *Response, error)

Gets current ThreatInsight configuration

func (*ThreatInsightConfigurationResource) UpdateConfiguration added in v2.5.2 

func (m *ThreatInsightConfigurationResource) UpdateConfiguration(ctx context.Context, body ThreatInsightConfiguration) (*ThreatInsightConfiguration, *Response, error)

Updates ThreatInsight configuration

type TokenAuthorizationServerPolicyRuleAction added in v2.3.0 

type TokenAuthorizationServerPolicyRuleAction struct {
	AccessTokenLifetimeMinutes     int64                                               `json:"-"`
	AccessTokenLifetimeMinutesPtr  *int64                                              `json:"accessTokenLifetimeMinutes"`
	InlineHook                     *TokenAuthorizationServerPolicyRuleActionInlineHook `json:"inlineHook,omitempty"`
	RefreshTokenLifetimeMinutes    int64                                               `json:"-"`
	RefreshTokenLifetimeMinutesPtr *int64                                              `json:"refreshTokenLifetimeMinutes"`
	RefreshTokenWindowMinutes      int64                                               `json:"-"`
	RefreshTokenWindowMinutesPtr   *int64                                              `json:"refreshTokenWindowMinutes"`
}

func (*TokenAuthorizationServerPolicyRuleAction) MarshalJSON added in v2.17.0 

func (a *TokenAuthorizationServerPolicyRuleAction) MarshalJSON() ([]byte, error)

func (*TokenAuthorizationServerPolicyRuleAction) UnmarshalJSON added in v2.17.0 

func (a *TokenAuthorizationServerPolicyRuleAction) UnmarshalJSON(data []byte) error

type TokenAuthorizationServerPolicyRuleActionInlineHook added in v2.5.2 

type TokenAuthorizationServerPolicyRuleActionInlineHook struct {
	Id string `json:"id,omitempty"`
}

type TokenUserFactor 

type TokenUserFactor struct {
	Embedded    interface{}             `json:"_embedded,omitempty"`
	Links       interface{}             `json:"_links,omitempty"`
	Created     *time.Time              `json:"created,omitempty"`
	FactorType  string                  `json:"factorType,omitempty"`
	Id          string                  `json:"id,omitempty"`
	LastUpdated *time.Time              `json:"lastUpdated,omitempty"`
	Provider    string                  `json:"provider,omitempty"`
	Status      string                  `json:"status,omitempty"`
	Verify      *VerifyFactorRequest    `json:"verify,omitempty"`
	Profile     *TokenUserFactorProfile `json:"profile,omitempty"`
}

func NewTokenUserFactor 

func NewTokenUserFactor() *TokenUserFactor

func (*TokenUserFactor) IsUserFactorInstance 

func (a *TokenUserFactor) IsUserFactorInstance() bool

type TokenUserFactorProfile 

type TokenUserFactorProfile struct {
	CredentialId string `json:"credentialId,omitempty"`
}

func NewTokenUserFactorProfile 

func NewTokenUserFactorProfile() *TokenUserFactorProfile

func (*TokenUserFactorProfile) IsUserFactorInstance 

func (a *TokenUserFactorProfile) IsUserFactorInstance() bool

type TotpUserFactor 

type TotpUserFactor struct {
	Embedded    interface{}            `json:"_embedded,omitempty"`
	Links       interface{}            `json:"_links,omitempty"`
	Created     *time.Time             `json:"created,omitempty"`
	FactorType  string                 `json:"factorType,omitempty"`
	Id          string                 `json:"id,omitempty"`
	LastUpdated *time.Time             `json:"lastUpdated,omitempty"`
	Provider    string                 `json:"provider,omitempty"`
	Status      string                 `json:"status,omitempty"`
	Verify      *VerifyFactorRequest   `json:"verify,omitempty"`
	Profile     *TotpUserFactorProfile `json:"profile,omitempty"`
}

func NewTotpUserFactor 

func NewTotpUserFactor() *TotpUserFactor

func (*TotpUserFactor) IsUserFactorInstance 

func (a *TotpUserFactor) IsUserFactorInstance() bool

type TotpUserFactorProfile 

type TotpUserFactorProfile struct {
	CredentialId string `json:"credentialId,omitempty"`
}

func NewTotpUserFactorProfile 

func NewTotpUserFactorProfile() *TotpUserFactorProfile

func (*TotpUserFactorProfile) IsUserFactorInstance 

func (a *TotpUserFactorProfile) IsUserFactorInstance() bool

type TrustedOrigin 

type TrustedOrigin struct {
	Links         interface{} `json:"_links,omitempty"`
	Created       *time.Time  `json:"created,omitempty"`
	CreatedBy     string      `json:"createdBy,omitempty"`
	Id            string      `json:"id,omitempty"`
	LastUpdated   *time.Time  `json:"lastUpdated,omitempty"`
	LastUpdatedBy string      `json:"lastUpdatedBy,omitempty"`
	Name          string      `json:"name,omitempty"`
	Origin        string      `json:"origin,omitempty"`
	Scopes        []*Scope    `json:"scopes,omitempty"`
	Status        string      `json:"status,omitempty"`
}

type TrustedOriginResource 

type TrustedOriginResource resource

func (*TrustedOriginResource) ActivateOrigin 

func (m *TrustedOriginResource) ActivateOrigin(ctx context.Context, trustedOriginId string) (*TrustedOrigin, *Response, error)

func (*TrustedOriginResource) CreateOrigin 

func (m *TrustedOriginResource) CreateOrigin(ctx context.Context, body TrustedOrigin) (*TrustedOrigin, *Response, error)

func (*TrustedOriginResource) DeactivateOrigin 

func (m *TrustedOriginResource) DeactivateOrigin(ctx context.Context, trustedOriginId string) (*TrustedOrigin, *Response, error)

func (*TrustedOriginResource) DeleteOrigin 

func (m *TrustedOriginResource) DeleteOrigin(ctx context.Context, trustedOriginId string) (*Response, error)

func (*TrustedOriginResource) GetOrigin 

func (m *TrustedOriginResource) GetOrigin(ctx context.Context, trustedOriginId string) (*TrustedOrigin, *Response, error)

func (*TrustedOriginResource) ListOrigins 

func (m *TrustedOriginResource) ListOrigins(ctx context.Context, qp *query.Params) ([]*TrustedOrigin, *Response, error)

func (*TrustedOriginResource) UpdateOrigin 

func (m *TrustedOriginResource) UpdateOrigin(ctx context.Context, trustedOriginId string, body TrustedOrigin) (*TrustedOrigin, *Response, error)

type U2fUserFactor 

type U2fUserFactor struct {
	Embedded    interface{}           `json:"_embedded,omitempty"`
	Links       interface{}           `json:"_links,omitempty"`
	Created     *time.Time            `json:"created,omitempty"`
	FactorType  string                `json:"factorType,omitempty"`
	Id          string                `json:"id,omitempty"`
	LastUpdated *time.Time            `json:"lastUpdated,omitempty"`
	Provider    string                `json:"provider,omitempty"`
	Status      string                `json:"status,omitempty"`
	Verify      *VerifyFactorRequest  `json:"verify,omitempty"`
	Profile     *U2fUserFactorProfile `json:"profile,omitempty"`
}

func NewU2fUserFactor 

func NewU2fUserFactor() *U2fUserFactor

func (*U2fUserFactor) IsUserFactorInstance 

func (a *U2fUserFactor) IsUserFactorInstance() bool

type U2fUserFactorProfile 

type U2fUserFactorProfile struct {
	CredentialId string `json:"credentialId,omitempty"`
}

func NewU2fUserFactorProfile 

func NewU2fUserFactorProfile() *U2fUserFactorProfile

func (*U2fUserFactorProfile) IsUserFactorInstance 

func (a *U2fUserFactorProfile) IsUserFactorInstance() bool

type User 

type User struct {
	Embedded              interface{}      `json:"_embedded,omitempty"`
	Links                 interface{}      `json:"_links,omitempty"`
	Activated             *time.Time       `json:"activated,omitempty"`
	Created               *time.Time       `json:"created,omitempty"`
	Credentials           *UserCredentials `json:"credentials,omitempty"`
	Id                    string           `json:"id,omitempty"`
	LastLogin             *time.Time       `json:"lastLogin,omitempty"`
	LastUpdated           *time.Time       `json:"lastUpdated,omitempty"`
	PasswordChanged       *time.Time       `json:"passwordChanged,omitempty"`
	Profile               *UserProfile     `json:"profile,omitempty"`
	Status                string           `json:"status,omitempty"`
	StatusChanged         *time.Time       `json:"statusChanged,omitempty"`
	TransitioningToStatus string           `json:"transitioningToStatus,omitempty"`
	Type                  *UserType        `json:"type,omitempty"`
}

type UserActivationToken 

type UserActivationToken struct {
	ActivationToken string `json:"activationToken,omitempty"`
	ActivationUrl   string `json:"activationUrl,omitempty"`
}

type UserAgent 

type UserAgent struct {
	// contains filtered or unexported fields
}

func NewUserAgent 

func NewUserAgent(config *config) UserAgent

func (UserAgent) String 

func (ua UserAgent) String() string

type UserCondition 

type UserCondition struct {
	Exclude []string `json:"exclude,omitempty"`
	Include []string `json:"include,omitempty"`
}

func NewUserCondition added in v2.10.1 

func NewUserCondition() *UserCondition

func (*UserCondition) IsPolicyInstance added in v2.10.1 

func (a *UserCondition) IsPolicyInstance() bool

type UserCredentials 

type UserCredentials struct {
	Password         *PasswordCredential         `json:"password,omitempty"`
	Provider         *AuthenticationProvider     `json:"provider,omitempty"`
	RecoveryQuestion *RecoveryQuestionCredential `json:"recovery_question,omitempty"`
}

type UserFactor 

type UserFactor struct {
	Embedded    interface{}          `json:"_embedded,omitempty"`
	Links       interface{}          `json:"_links,omitempty"`
	Created     *time.Time           `json:"created,omitempty"`
	FactorType  string               `json:"factorType,omitempty"`
	Id          string               `json:"id,omitempty"`
	LastUpdated *time.Time           `json:"lastUpdated,omitempty"`
	Provider    string               `json:"provider,omitempty"`
	Status      string               `json:"status,omitempty"`
	Verify      *VerifyFactorRequest `json:"verify,omitempty"`
}

func NewUserFactor 

func NewUserFactor() *UserFactor

func (*UserFactor) IsUserFactorInstance 

func (a *UserFactor) IsUserFactorInstance() bool

type UserFactorResource 

type UserFactorResource resource

func (*UserFactorResource) ActivateFactor 

func (m *UserFactorResource) ActivateFactor(ctx context.Context, userId string, factorId string, body ActivateFactorRequest, factorInstance Factor) (Factor, *Response, error)

The `sms` and `token:software:totp` factor types require activation to complete the enrollment process.

func (*UserFactorResource) DeleteFactor 

func (m *UserFactorResource) DeleteFactor(ctx context.Context, userId string, factorId string) (*Response, error)

Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor.

func (*UserFactorResource) EnrollFactor 

func (m *UserFactorResource) EnrollFactor(ctx context.Context, userId string, body Factor, qp *query.Params) (Factor, *Response, error)

Enrolls a user with a supported factor.

func (*UserFactorResource) GetFactor 

func (m *UserFactorResource) GetFactor(ctx context.Context, userId string, factorId string, factorInstance Factor) (Factor, *Response, error)

Fetches a factor for the specified user

func (*UserFactorResource) GetFactorTransactionStatus 

func (m *UserFactorResource) GetFactorTransactionStatus(ctx context.Context, userId string, factorId string, transactionId string) (*VerifyUserFactorResponse, *Response, error)

Polls factors verification transaction for status.

func (*UserFactorResource) ListFactors 

func (m *UserFactorResource) ListFactors(ctx context.Context, userId string) ([]Factor, *Response, error)

Enumerates all the enrolled factors for the specified user

func (*UserFactorResource) ListSupportedFactors 

func (m *UserFactorResource) ListSupportedFactors(ctx context.Context, userId string) ([]Factor, *Response, error)

Enumerates all the supported factors that can be enrolled for the specified user

func (*UserFactorResource) ListSupportedSecurityQuestions 

func (m *UserFactorResource) ListSupportedSecurityQuestions(ctx context.Context, userId string) ([]*SecurityQuestion, *Response, error)

Enumerates all available security questions for a user's `question` factor

func (*UserFactorResource) VerifyFactor 

func (m *UserFactorResource) VerifyFactor(ctx context.Context, userId string, factorId string, body VerifyFactorRequest, factorInstance Factor, qp *query.Params) (*VerifyUserFactorResponse, *Response, error)

Verifies an OTP for a `token` or `token:hardware` factor

type UserIdString added in v2.8.0 

type UserIdString struct {
	Links  interface{} `json:"_links,omitempty"`
	UserId string      `json:"userId,omitempty"`
}

type UserIdentifierConditionEvaluatorPattern 

type UserIdentifierConditionEvaluatorPattern struct {
	MatchType string `json:"matchType,omitempty"`
	Value     string `json:"value,omitempty"`
}

func NewUserIdentifierConditionEvaluatorPattern added in v2.10.1 

func NewUserIdentifierConditionEvaluatorPattern() *UserIdentifierConditionEvaluatorPattern

func (*UserIdentifierConditionEvaluatorPattern) IsPolicyInstance added in v2.10.1 

func (a *UserIdentifierConditionEvaluatorPattern) IsPolicyInstance() bool

type UserIdentifierPolicyRuleCondition 

type UserIdentifierPolicyRuleCondition struct {
	Attribute string                                     `json:"attribute,omitempty"`
	Patterns  []*UserIdentifierConditionEvaluatorPattern `json:"patterns,omitempty"`
	Type      string                                     `json:"type,omitempty"`
}

func NewUserIdentifierPolicyRuleCondition added in v2.10.1 

func NewUserIdentifierPolicyRuleCondition() *UserIdentifierPolicyRuleCondition

func (*UserIdentifierPolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *UserIdentifierPolicyRuleCondition) IsPolicyInstance() bool

type UserIdentityProviderLinkRequest 

type UserIdentityProviderLinkRequest struct {
	ExternalId string `json:"externalId,omitempty"`
}

func NewUserIdentityProviderLinkRequest added in v2.10.1 

func NewUserIdentityProviderLinkRequest() *UserIdentityProviderLinkRequest

func (*UserIdentityProviderLinkRequest) IsPolicyInstance added in v2.10.1 

func (a *UserIdentityProviderLinkRequest) IsPolicyInstance() bool

type UserLifecycleAttributePolicyRuleCondition 

type UserLifecycleAttributePolicyRuleCondition struct {
	AttributeName string `json:"attributeName,omitempty"`
	MatchingValue string `json:"matchingValue,omitempty"`
}

func NewUserLifecycleAttributePolicyRuleCondition added in v2.10.1 

func NewUserLifecycleAttributePolicyRuleCondition() *UserLifecycleAttributePolicyRuleCondition

func (*UserLifecycleAttributePolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *UserLifecycleAttributePolicyRuleCondition) IsPolicyInstance() bool

type UserNextLogin 

type UserNextLogin string

type UserPolicyRuleCondition 

type UserPolicyRuleCondition struct {
	Exclude                []string                                   `json:"exclude,omitempty"`
	Inactivity             *InactivityPolicyRuleCondition             `json:"inactivity,omitempty"`
	Include                []string                                   `json:"include,omitempty"`
	LifecycleExpiration    *LifecycleExpirationPolicyRuleCondition    `json:"lifecycleExpiration,omitempty"`
	PasswordExpiration     *PasswordExpirationPolicyRuleCondition     `json:"passwordExpiration,omitempty"`
	UserLifecycleAttribute *UserLifecycleAttributePolicyRuleCondition `json:"userLifecycleAttribute,omitempty"`
}

func NewUserPolicyRuleCondition added in v2.10.1 

func NewUserPolicyRuleCondition() *UserPolicyRuleCondition

func (*UserPolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *UserPolicyRuleCondition) IsPolicyInstance() bool

type UserProfile 

type UserProfile map[string]interface{}

type UserResource 

type UserResource resource

func (*UserResource) ActivateUser 

func (m *UserResource) ActivateUser(ctx context.Context, userId string, qp *query.Params) (*UserActivationToken, *Response, error)

Activates a user. This operation can only be performed on users with a `STAGED` status. Activation of a user is an asynchronous operation. The user will have the `transitioningToStatus` property with a value of `ACTIVE` during activation to indicate that the user hasn't completed the asynchronous operation. The user will have a status of `ACTIVE` when the activation process is complete.

func (*UserResource) AddAllAppsAsTargetToRole 

func (m *UserResource) AddAllAppsAsTargetToRole(ctx context.Context, userId string, roleId string) (*Response, error)

func (*UserResource) AddApplicationTargetToAdminRoleForUser 

func (m *UserResource) AddApplicationTargetToAdminRoleForUser(ctx context.Context, userId string, roleId string, appName string) (*Response, error)

func (*UserResource) AddApplicationTargetToAppAdminRoleForUser 

func (m *UserResource) AddApplicationTargetToAppAdminRoleForUser(ctx context.Context, userId string, roleId string, appName string, applicationId string) (*Response, error)

Add App Instance Target to App Administrator Role given to a User

func (*UserResource) AddGroupTargetToRole 

func (m *UserResource) AddGroupTargetToRole(ctx context.Context, userId string, roleId string, groupId string) (*Response, error)

func (*UserResource) AssignRoleToUser 

func (m *UserResource) AssignRoleToUser(ctx context.Context, userId string, body AssignRoleRequest, qp *query.Params) (*Role, *Response, error)

Assigns a role to a user.

func (*UserResource) ChangePassword 

func (m *UserResource) ChangePassword(ctx context.Context, userId string, body ChangePasswordRequest, qp *query.Params) (*UserCredentials, *Response, error)

Changes a user's password by validating the user's current password. This operation can only be performed on users in `STAGED`, `ACTIVE`, `PASSWORD_EXPIRED`, or `RECOVERY` status that have a valid password credential

func (*UserResource) ChangeRecoveryQuestion 

func (m *UserResource) ChangeRecoveryQuestion(ctx context.Context, userId string, body UserCredentials) (*UserCredentials, *Response, error)

Changes a user's recovery question & answer credential by validating the user's current password. This operation can only be performed on users in **STAGED**, **ACTIVE** or **RECOVERY** `status` that have a valid password credential

func (*UserResource) ClearUserSessions 

func (m *UserResource) ClearUserSessions(ctx context.Context, userId string, qp *query.Params) (*Response, error)

Removes all active identity provider sessions. This forces the user to authenticate on the next operation. Optionally revokes OpenID Connect and OAuth refresh and access tokens issued to the user.

func (*UserResource) CreateUser 

func (m *UserResource) CreateUser(ctx context.Context, body CreateUserRequest, qp *query.Params) (*User, *Response, error)

Creates a new user in your Okta organization with or without credentials.

func (*UserResource) DeactivateOrDeleteUser 

func (m *UserResource) DeactivateOrDeleteUser(ctx context.Context, userId string, qp *query.Params) (*Response, error)

Deletes a user permanently. This operation can only be performed on users that have a `DEPROVISIONED` status. **This action cannot be recovered!**

func (*UserResource) DeactivateUser 

func (m *UserResource) DeactivateUser(ctx context.Context, userId string, qp *query.Params) (*Response, error)

Deactivates a user. This operation can only be performed on users that do not have a `DEPROVISIONED` status. While the asynchronous operation (triggered by HTTP header `Prefer: respond-async`) is proceeding the user's `transitioningToStatus` property is `DEPROVISIONED`. The user's status is `DEPROVISIONED` when the deactivation process is complete.

func (*UserResource) ExpirePassword 

func (m *UserResource) ExpirePassword(ctx context.Context, userId string) (*User, *Response, error)

This operation transitions the user to the status of `PASSWORD_EXPIRED` so that the user is required to change their password at their next login.

func (*UserResource) ExpirePasswordAndGetTemporaryPassword 

func (m *UserResource) ExpirePasswordAndGetTemporaryPassword(ctx context.Context, userId string) (*TempPassword, *Response, error)

This operation transitions the user to the status of `PASSWORD_EXPIRED` and the user's password is reset to a temporary password that is returned.

func (*UserResource) ForgotPasswordGenerateOneTimeToken 

func (m *UserResource) ForgotPasswordGenerateOneTimeToken(ctx context.Context, userId string, qp *query.Params) (*ForgotPasswordResponse, *Response, error)

Generates a one-time token (OTT) that can be used to reset a user's password

func (*UserResource) ForgotPasswordSetNewPassword 

func (m *UserResource) ForgotPasswordSetNewPassword(ctx context.Context, userId string, body UserCredentials, qp *query.Params) (*ForgotPasswordResponse, *Response, error)

Sets a new password for a user by validating the user's answer to their current recovery question

func (*UserResource) GetLinkedObjectsForUser 

func (m *UserResource) GetLinkedObjectsForUser(ctx context.Context, userId string, relationshipName string, qp *query.Params) ([]*ResponseLinks, *Response, error)

Get linked objects for a user, relationshipName can be a primary or associated relationship name

func (*UserResource) GetRefreshTokenForUserAndClient 

func (m *UserResource) GetRefreshTokenForUserAndClient(ctx context.Context, userId string, clientId string, tokenId string, qp *query.Params) (*OAuth2RefreshToken, *Response, error)

Gets a refresh token issued for the specified User and Client.

func (*UserResource) GetUser 

func (m *UserResource) GetUser(ctx context.Context, userId string) (*User, *Response, error)

Fetches a user from your Okta organization.

func (*UserResource) GetUserGrant 

func (m *UserResource) GetUserGrant(ctx context.Context, userId string, grantId string, qp *query.Params) (*OAuth2ScopeConsentGrant, *Response, error)

Gets a grant for the specified user

func (*UserResource) GetUserRole added in v2.6.2 

func (m *UserResource) GetUserRole(ctx context.Context, userId string, roleId string) (*Role, *Response, error)

Gets role that is assigne to user.

func (*UserResource) GetUserSubscriptionByNotificationType added in v2.10.0 

func (m *UserResource) GetUserSubscriptionByNotificationType(ctx context.Context, userId string, notificationType string) (*Subscription, *Response, error)

Get the subscriptions of a User with a specific notification type. Only gets subscriptions for current user. An AccessDeniedException message is sent if requests are made from other users. 

func (m *UserResource) ListAppLinks(ctx context.Context, userId string) ([]*AppLink, *Response, error)

Fetches appLinks for all direct or indirect (via group membership) assigned applications.

func (*UserResource) ListApplicationTargetsForApplicationAdministratorRoleForUser 

func (m *UserResource) ListApplicationTargetsForApplicationAdministratorRoleForUser(ctx context.Context, userId string, roleId string, qp *query.Params) ([]*CatalogApplication, *Response, error)

Lists all App targets for an `APP_ADMIN` Role assigned to a User. This methods return list may include full Applications or Instances. The response for an instance will have an `ID` value, while Application will not have an ID.

func (*UserResource) ListAssignedRolesForUser 

func (m *UserResource) ListAssignedRolesForUser(ctx context.Context, userId string, qp *query.Params) ([]*Role, *Response, error)

Lists all roles assigned to a user.

func (*UserResource) ListGrantsForUserAndClient 

func (m *UserResource) ListGrantsForUserAndClient(ctx context.Context, userId string, clientId string, qp *query.Params) ([]*OAuth2ScopeConsentGrant, *Response, error)

Lists all grants for a specified user and client

func (*UserResource) ListGroupTargetsForRole 

func (m *UserResource) ListGroupTargetsForRole(ctx context.Context, userId string, roleId string, qp *query.Params) ([]*Group, *Response, error)

func (*UserResource) ListRefreshTokensForUserAndClient 

func (m *UserResource) ListRefreshTokensForUserAndClient(ctx context.Context, userId string, clientId string, qp *query.Params) ([]*OAuth2RefreshToken, *Response, error)

Lists all refresh tokens issued for the specified User and Client.

func (*UserResource) ListUserClients 

func (m *UserResource) ListUserClients(ctx context.Context, userId string) ([]*OAuth2Client, *Response, error)

Lists all client resources for which the specified user has grants or tokens.

func (*UserResource) ListUserGrants 

func (m *UserResource) ListUserGrants(ctx context.Context, userId string, qp *query.Params) ([]*OAuth2ScopeConsentGrant, *Response, error)

Lists all grants for the specified user

func (*UserResource) ListUserGroups 

func (m *UserResource) ListUserGroups(ctx context.Context, userId string) ([]*Group, *Response, error)

Fetches the groups of which the user is a member.

func (*UserResource) ListUserIdentityProviders 

func (m *UserResource) ListUserIdentityProviders(ctx context.Context, userId string) ([]*IdentityProvider, *Response, error)

Lists the IdPs associated with the user.

func (*UserResource) ListUserSubscriptions added in v2.10.0 

func (m *UserResource) ListUserSubscriptions(ctx context.Context, userId string) ([]*Subscription, *Response, error)

List subscriptions of a User. Only lists subscriptions for current user. An AccessDeniedException message is sent if requests are made from other users.

func (*UserResource) ListUsers 

func (m *UserResource) ListUsers(ctx context.Context, qp *query.Params) ([]*User, *Response, error)

Lists users that do not have a status of 'DEPROVISIONED' (by default), up to the maximum (200 for most orgs), with pagination in most cases. A subset of users can be returned that match a supported filter expression or search criteria.

func (*UserResource) PartialUpdateUser 

func (m *UserResource) PartialUpdateUser(ctx context.Context, userId string, body User, qp *query.Params) (*User, *Response, error)

Update a user's profile or credentials with partial update semantics.

func (*UserResource) ReactivateUser 

func (m *UserResource) ReactivateUser(ctx context.Context, userId string, qp *query.Params) (*UserActivationToken, *Response, error)

Reactivates a user. This operation can only be performed on users with a `PROVISIONED` status. This operation restarts the activation workflow if for some reason the user activation was not completed when using the activationToken from [Activate User](#activate-user).

func (*UserResource) RemoveApplicationTargetFromAdministratorRoleForUser 

func (m *UserResource) RemoveApplicationTargetFromAdministratorRoleForUser(ctx context.Context, userId string, roleId string, appName string, applicationId string) (*Response, error)

Remove App Instance Target to App Administrator Role given to a User

func (*UserResource) RemoveApplicationTargetFromApplicationAdministratorRoleForUser 

func (m *UserResource) RemoveApplicationTargetFromApplicationAdministratorRoleForUser(ctx context.Context, userId string, roleId string, appName string) (*Response, error)

func (*UserResource) RemoveGroupTargetFromRole 

func (m *UserResource) RemoveGroupTargetFromRole(ctx context.Context, userId string, roleId string, groupId string) (*Response, error)

func (*UserResource) RemoveLinkedObjectForUser 

func (m *UserResource) RemoveLinkedObjectForUser(ctx context.Context, userId string, relationshipName string) (*Response, error)

Delete linked objects for a user, relationshipName can be ONLY a primary relationship name

func (*UserResource) RemoveRoleFromUser 

func (m *UserResource) RemoveRoleFromUser(ctx context.Context, userId string, roleId string) (*Response, error)

Unassigns a role from a user.

func (*UserResource) ResetFactors 

func (m *UserResource) ResetFactors(ctx context.Context, userId string) (*Response, error)

This operation resets all factors for the specified user. All MFA factor enrollments returned to the unenrolled state. The user's status remains ACTIVE. This link is present only if the user is currently enrolled in one or more MFA factors.

func (*UserResource) ResetPassword 

func (m *UserResource) ResetPassword(ctx context.Context, userId string, qp *query.Params) (*ResetPasswordToken, *Response, error)

Generates a one-time token (OTT) that can be used to reset a user's password. The OTT link can be automatically emailed to the user or returned to the API caller and distributed using a custom flow.

func (*UserResource) RevokeGrantsForUserAndClient 

func (m *UserResource) RevokeGrantsForUserAndClient(ctx context.Context, userId string, clientId string) (*Response, error)

Revokes all grants for the specified user and client

func (*UserResource) RevokeTokenForUserAndClient 

func (m *UserResource) RevokeTokenForUserAndClient(ctx context.Context, userId string, clientId string, tokenId string) (*Response, error)

Revokes the specified refresh token.

func (*UserResource) RevokeTokensForUserAndClient 

func (m *UserResource) RevokeTokensForUserAndClient(ctx context.Context, userId string, clientId string) (*Response, error)

Revokes all refresh tokens issued for the specified User and Client.

func (*UserResource) RevokeUserGrant 

func (m *UserResource) RevokeUserGrant(ctx context.Context, userId string, grantId string) (*Response, error)

Revokes one grant for a specified user

func (*UserResource) RevokeUserGrants 

func (m *UserResource) RevokeUserGrants(ctx context.Context, userId string) (*Response, error)

Revokes all grants for a specified user

func (*UserResource) SetLinkedObjectForUser 

func (m *UserResource) SetLinkedObjectForUser(ctx context.Context, associatedUserId string, primaryRelationshipName string, primaryUserId string) (*Response, error)

func (*UserResource) SuspendUser 

func (m *UserResource) SuspendUser(ctx context.Context, userId string) (*Response, error)

Suspends a user. This operation can only be performed on users with an `ACTIVE` status. The user will have a status of `SUSPENDED` when the process is complete.

func (*UserResource) UnlockUser 

func (m *UserResource) UnlockUser(ctx context.Context, userId string) (*Response, error)

Unlocks a user with a `LOCKED_OUT` status and returns them to `ACTIVE` status. Users will be able to login with their current password.

func (*UserResource) UnsuspendUser 

func (m *UserResource) UnsuspendUser(ctx context.Context, userId string) (*Response, error)

Unsuspends a user and returns them to the `ACTIVE` state. This operation can only be performed on users that have a `SUSPENDED` status.

func (*UserResource) UpdateUser 

func (m *UserResource) UpdateUser(ctx context.Context, userId string, body User, qp *query.Params) (*User, *Response, error)

Update a user's profile and/or credentials using strict-update semantics.

type UserSchema added in v2.5.2 

type UserSchema struct {
	Schema      string                 `json:"$schema,omitempty"`
	Links       interface{}            `json:"_links,omitempty"`
	Created     string                 `json:"created,omitempty"`
	Definitions *UserSchemaDefinitions `json:"definitions,omitempty"`
	Id          string                 `json:"id,omitempty"`
	LastUpdated string                 `json:"lastUpdated,omitempty"`
	Name        string                 `json:"name,omitempty"`
	Properties  *UserSchemaProperties  `json:"properties,omitempty"`
	Title       string                 `json:"title,omitempty"`
	Type        string                 `json:"type,omitempty"`
}

type UserSchemaAttribute added in v2.5.2 

type UserSchemaAttribute struct {
	Description       string                           `json:"description,omitempty"`
	Enum              []interface{}                    `json:"enum,omitempty"`
	ExternalName      string                           `json:"externalName,omitempty"`
	ExternalNamespace string                           `json:"externalNamespace,omitempty"`
	Items             *UserSchemaAttributeItems        `json:"items,omitempty"`
	Master            *UserSchemaAttributeMaster       `json:"master,omitempty"`
	MaxLength         int64                            `json:"-"`
	MaxLengthPtr      *int64                           `json:"maxLength,omitempty"`
	MinLength         int64                            `json:"-"`
	MinLengthPtr      *int64                           `json:"minLength,omitempty"`
	Mutability        string                           `json:"mutability,omitempty"`
	OneOf             []*UserSchemaAttributeEnum       `json:"oneOf,omitempty"`
	Pattern           *string                          `json:"pattern,omitempty"`
	Permissions       []*UserSchemaAttributePermission `json:"permissions,omitempty"`
	Required          *bool                            `json:"required,omitempty"`
	Scope             string                           `json:"scope,omitempty"`
	Title             string                           `json:"title,omitempty"`
	Type              string                           `json:"type,omitempty"`
	Union             string                           `json:"union,omitempty"`
	Unique            string                           `json:"unique,omitempty"`
}

func (*UserSchemaAttribute) MarshalJSON added in v2.17.0 

func (a *UserSchemaAttribute) MarshalJSON() ([]byte, error)

func (*UserSchemaAttribute) UnmarshalJSON added in v2.17.0 

func (a *UserSchemaAttribute) UnmarshalJSON(data []byte) error

type UserSchemaAttributeEnum added in v2.5.2 

type UserSchemaAttributeEnum struct {
	Const interface{} `json:"const,omitempty"`
	Title string      `json:"title,omitempty"`
}

type UserSchemaAttributeItems added in v2.5.2 

type UserSchemaAttributeItems struct {
	Enum  []interface{}              `json:"enum,omitempty"`
	OneOf []*UserSchemaAttributeEnum `json:"oneOf,omitempty"`
	Type  string                     `json:"type,omitempty"`
}

type UserSchemaAttributeMaster added in v2.5.2 

type UserSchemaAttributeMaster struct {
	Priority []*UserSchemaAttributeMasterPriority `json:"priority,omitempty"`
	Type     string                               `json:"type,omitempty"`
}

type UserSchemaAttributeMasterPriority added in v2.5.2 

type UserSchemaAttributeMasterPriority struct {
	Type  string `json:"type,omitempty"`
	Value string `json:"value,omitempty"`
}

type UserSchemaAttributeMasterType added in v2.5.2 

type UserSchemaAttributeMasterType string

type UserSchemaAttributePermission added in v2.5.2 

type UserSchemaAttributePermission struct {
	Action    string `json:"action,omitempty"`
	Principal string `json:"principal,omitempty"`
}

type UserSchemaAttributeScope added in v2.5.2 

type UserSchemaAttributeScope string

type UserSchemaAttributeType added in v2.5.2 

type UserSchemaAttributeType string

type UserSchemaAttributeUnion added in v2.5.2 

type UserSchemaAttributeUnion string

type UserSchemaBase added in v2.5.2 

type UserSchemaBase struct {
	Id         string                          `json:"id,omitempty"`
	Properties map[string]*UserSchemaAttribute `json:"properties,omitempty"`
	Required   []string                        `json:"required,omitempty"`
	Type       string                          `json:"type,omitempty"`
}

type UserSchemaBaseProperties added in v2.5.2 

type UserSchemaBaseProperties struct {
	City              *UserSchemaAttribute `json:"city,omitempty"`
	CostCenter        *UserSchemaAttribute `json:"costCenter,omitempty"`
	CountryCode       *UserSchemaAttribute `json:"countryCode,omitempty"`
	Department        *UserSchemaAttribute `json:"department,omitempty"`
	DisplayName       *UserSchemaAttribute `json:"displayName,omitempty"`
	Division          *UserSchemaAttribute `json:"division,omitempty"`
	Email             *UserSchemaAttribute `json:"email,omitempty"`
	EmployeeNumber    *UserSchemaAttribute `json:"employeeNumber,omitempty"`
	FirstName         *UserSchemaAttribute `json:"firstName,omitempty"`
	HonorificPrefix   *UserSchemaAttribute `json:"honorificPrefix,omitempty"`
	HonorificSuffix   *UserSchemaAttribute `json:"honorificSuffix,omitempty"`
	LastName          *UserSchemaAttribute `json:"lastName,omitempty"`
	Locale            *UserSchemaAttribute `json:"locale,omitempty"`
	Login             *UserSchemaAttribute `json:"login,omitempty"`
	Manager           *UserSchemaAttribute `json:"manager,omitempty"`
	ManagerId         *UserSchemaAttribute `json:"managerId,omitempty"`
	MiddleName        *UserSchemaAttribute `json:"middleName,omitempty"`
	MobilePhone       *UserSchemaAttribute `json:"mobilePhone,omitempty"`
	NickName          *UserSchemaAttribute `json:"nickName,omitempty"`
	Organization      *UserSchemaAttribute `json:"organization,omitempty"`
	PostalAddress     *UserSchemaAttribute `json:"postalAddress,omitempty"`
	PreferredLanguage *UserSchemaAttribute `json:"preferredLanguage,omitempty"`
	PrimaryPhone      *UserSchemaAttribute `json:"primaryPhone,omitempty"`
	ProfileUrl        *UserSchemaAttribute `json:"profileUrl,omitempty"`
	SecondEmail       *UserSchemaAttribute `json:"secondEmail,omitempty"`
	State             *UserSchemaAttribute `json:"state,omitempty"`
	StreetAddress     *UserSchemaAttribute `json:"streetAddress,omitempty"`
	Timezone          *UserSchemaAttribute `json:"timezone,omitempty"`
	Title             *UserSchemaAttribute `json:"title,omitempty"`
	UserType          *UserSchemaAttribute `json:"userType,omitempty"`
	ZipCode           *UserSchemaAttribute `json:"zipCode,omitempty"`
}

type UserSchemaDefinitions added in v2.5.2 

type UserSchemaDefinitions struct {
	Base   *UserSchemaBase   `json:"base,omitempty"`
	Custom *UserSchemaPublic `json:"custom,omitempty"`
}

type UserSchemaProperties added in v2.5.2 

type UserSchemaProperties struct {
	Profile *UserSchemaPropertiesProfile `json:"profile,omitempty"`
}

type UserSchemaPropertiesProfile added in v2.5.2 

type UserSchemaPropertiesProfile struct {
	AllOf []*UserSchemaPropertiesProfileItem `json:"allOf,omitempty"`
}

type UserSchemaPropertiesProfileItem added in v2.5.2 

type UserSchemaPropertiesProfileItem struct {
	Ref string `json:"$ref,omitempty"`
}

type UserSchemaPublic added in v2.5.2 

type UserSchemaPublic struct {
	Id         string                          `json:"id,omitempty"`
	Properties map[string]*UserSchemaAttribute `json:"properties,omitempty"`
	Required   []string                        `json:"required,omitempty"`
	Type       string                          `json:"type,omitempty"`
}

type UserSchemaResource added in v2.5.2 

type UserSchemaResource resource

func (*UserSchemaResource) GetApplicationUserSchema added in v2.5.2 

func (m *UserSchemaResource) GetApplicationUserSchema(ctx context.Context, appInstanceId string) (*UserSchema, *Response, error)

Fetches the Schema for an App User

func (*UserSchemaResource) GetUserSchema added in v2.5.2 

func (m *UserSchemaResource) GetUserSchema(ctx context.Context, schemaId string) (*UserSchema, *Response, error)

Fetches the schema for a Schema Id.

func (*UserSchemaResource) UpdateApplicationUserProfile added in v2.5.2 

func (m *UserSchemaResource) UpdateApplicationUserProfile(ctx context.Context, appInstanceId string, body UserSchema) (*UserSchema, *Response, error)

Partial updates on the User Profile properties of the Application User Schema.

func (*UserSchemaResource) UpdateUserProfile added in v2.5.2 

func (m *UserSchemaResource) UpdateUserProfile(ctx context.Context, schemaId string, body UserSchema) (*UserSchema, *Response, error)

Partial updates on the User Profile properties of the user schema.

type UserStatus 

type UserStatus string

type UserStatusPolicyRuleCondition 

type UserStatusPolicyRuleCondition struct {
	Value string `json:"value,omitempty"`
}

func NewUserStatusPolicyRuleCondition added in v2.10.1 

func NewUserStatusPolicyRuleCondition() *UserStatusPolicyRuleCondition

func (*UserStatusPolicyRuleCondition) IsPolicyInstance added in v2.10.1 

func (a *UserStatusPolicyRuleCondition) IsPolicyInstance() bool

type UserType 

type UserType struct {
	Links         interface{} `json:"_links,omitempty"`
	Created       *time.Time  `json:"created,omitempty"`
	CreatedBy     string      `json:"createdBy,omitempty"`
	Default       *bool       `json:"default,omitempty"`
	Description   string      `json:"description,omitempty"`
	DisplayName   string      `json:"displayName,omitempty"`
	Id            string      `json:"id,omitempty"`
	LastUpdated   *time.Time  `json:"lastUpdated,omitempty"`
	LastUpdatedBy string      `json:"lastUpdatedBy,omitempty"`
	Name          string      `json:"name,omitempty"`
}

type UserTypeCondition added in v2.9.1 

type UserTypeCondition struct {
	Exclude []string `json:"exclude,omitempty"`
	Include []string `json:"include,omitempty"`
}

func NewUserTypeCondition added in v2.10.1 

func NewUserTypeCondition() *UserTypeCondition

func (*UserTypeCondition) IsPolicyInstance added in v2.10.1 

func (a *UserTypeCondition) IsPolicyInstance() bool

type UserTypeResource 

type UserTypeResource resource

func (*UserTypeResource) CreateUserType 

func (m *UserTypeResource) CreateUserType(ctx context.Context, body UserType) (*UserType, *Response, error)

Creates a new User Type. A default User Type is automatically created along with your org, and you may add another 9 User Types for a maximum of 10.

func (*UserTypeResource) DeleteUserType 

func (m *UserTypeResource) DeleteUserType(ctx context.Context, typeId string) (*Response, error)

Deletes a User Type permanently. This operation is not permitted for the default type, nor for any User Type that has existing users

func (*UserTypeResource) GetUserType 

func (m *UserTypeResource) GetUserType(ctx context.Context, typeId string) (*UserType, *Response, error)

Fetches a User Type by ID. The special identifier `default` may be used to fetch the default User Type.

func (*UserTypeResource) ListUserTypes 

func (m *UserTypeResource) ListUserTypes(ctx context.Context) ([]*UserType, *Response, error)

Fetches all User Types in your org

func (*UserTypeResource) ReplaceUserType 

func (m *UserTypeResource) ReplaceUserType(ctx context.Context, typeId string, body UserType) (*UserType, *Response, error)

Replace an existing User Type

func (*UserTypeResource) UpdateUserType 

func (m *UserTypeResource) UpdateUserType(ctx context.Context, typeId string, body UserType) (*UserType, *Response, error)

Updates an existing User Type

type UserVerificationEnum added in v2.9.1 

type UserVerificationEnum string

type VerificationMethod added in v2.9.1 

type VerificationMethod struct {
	Constraints      []*AccessPolicyConstraints `json:"constraints,omitempty"`
	FactorMode       string                     `json:"factorMode,omitempty"`
	InactivityPeriod string                     `json:"inactivityPeriod,omitempty"`
	ReauthenticateIn string                     `json:"reauthenticateIn,omitempty"`
	Type             string                     `json:"type,omitempty"`
}

func NewVerificationMethod added in v2.10.1 

func NewVerificationMethod() *VerificationMethod

func (*VerificationMethod) IsPolicyInstance added in v2.10.1 

func (a *VerificationMethod) IsPolicyInstance() bool

type VerifyFactorRequest 

type VerifyFactorRequest struct {
	ActivationToken  string `json:"activationToken,omitempty"`
	Answer           string `json:"answer,omitempty"`
	Attestation      string `json:"attestation,omitempty"`
	ClientData       string `json:"clientData,omitempty"`
	NextPassCode     string `json:"nextPassCode,omitempty"`
	PassCode         string `json:"passCode,omitempty"`
	RegistrationData string `json:"registrationData,omitempty"`
	StateToken       string `json:"stateToken,omitempty"`
}

func NewVerifyFactorRequest 

func NewVerifyFactorRequest() *VerifyFactorRequest

func (*VerifyFactorRequest) IsUserFactorInstance 

func (a *VerifyFactorRequest) IsUserFactorInstance() bool

type VerifyUserFactorResponse 

type VerifyUserFactorResponse struct {
	Embedded            interface{} `json:"_embedded,omitempty"`
	Links               interface{} `json:"_links,omitempty"`
	ExpiresAt           *time.Time  `json:"expiresAt,omitempty"`
	FactorResult        string      `json:"factorResult,omitempty"`
	FactorResultMessage string      `json:"factorResultMessage,omitempty"`
}

func NewVerifyUserFactorResponse added in v2.1.0 

func NewVerifyUserFactorResponse() *VerifyUserFactorResponse

func (*VerifyUserFactorResponse) IsUserFactorInstance added in v2.1.0 

func (a *VerifyUserFactorResponse) IsUserFactorInstance() bool

type WebAuthnUserFactor added in v2.1.0 

type WebAuthnUserFactor struct {
	Embedded    interface{}                `json:"_embedded,omitempty"`
	Links       interface{}                `json:"_links,omitempty"`
	Created     *time.Time                 `json:"created,omitempty"`
	FactorType  string                     `json:"factorType,omitempty"`
	Id          string                     `json:"id,omitempty"`
	LastUpdated *time.Time                 `json:"lastUpdated,omitempty"`
	Provider    string                     `json:"provider,omitempty"`
	Status      string                     `json:"status,omitempty"`
	Verify      *VerifyFactorRequest       `json:"verify,omitempty"`
	Profile     *WebAuthnUserFactorProfile `json:"profile,omitempty"`
}

func NewWebAuthnUserFactor added in v2.1.0 

func NewWebAuthnUserFactor() *WebAuthnUserFactor

func (*WebAuthnUserFactor) IsUserFactorInstance added in v2.1.0 

func (a *WebAuthnUserFactor) IsUserFactorInstance() bool

type WebAuthnUserFactorProfile added in v2.1.0 

type WebAuthnUserFactorProfile struct {
	AuthenticatorName string `json:"authenticatorName,omitempty"`
	CredentialId      string `json:"credentialId,omitempty"`
}

type WebUserFactor 

type WebUserFactor struct {
	Embedded    interface{}           `json:"_embedded,omitempty"`
	Links       interface{}           `json:"_links,omitempty"`
	Created     *time.Time            `json:"created,omitempty"`
	FactorType  string                `json:"factorType,omitempty"`
	Id          string                `json:"id,omitempty"`
	LastUpdated *time.Time            `json:"lastUpdated,omitempty"`
	Provider    string                `json:"provider,omitempty"`
	Status      string                `json:"status,omitempty"`
	Verify      *VerifyFactorRequest  `json:"verify,omitempty"`
	Profile     *WebUserFactorProfile `json:"profile,omitempty"`
}

func NewWebUserFactor 

func NewWebUserFactor() *WebUserFactor

func (*WebUserFactor) IsUserFactorInstance 

func (a *WebUserFactor) IsUserFactorInstance() bool

type WebUserFactorProfile 

type WebUserFactorProfile struct {
	CredentialId string `json:"credentialId,omitempty"`
}

func NewWebUserFactorProfile 

func NewWebUserFactorProfile() *WebUserFactorProfile

func (*WebUserFactorProfile) IsUserFactorInstance 

func (a *WebUserFactorProfile) IsUserFactorInstance() bool

type WsFederationApplication 

type WsFederationApplication struct {
	Embedded      interface{}                      `json:"_embedded,omitempty"`
	Links         interface{}                      `json:"_links,omitempty"`
	Accessibility *ApplicationAccessibility        `json:"accessibility,omitempty"`
	Created       *time.Time                       `json:"created,omitempty"`
	Credentials   *ApplicationCredentials          `json:"credentials,omitempty"`
	Features      []string                         `json:"features,omitempty"`
	Id            string                           `json:"id,omitempty"`
	Label         string                           `json:"label,omitempty"`
	LastUpdated   *time.Time                       `json:"lastUpdated,omitempty"`
	Licensing     *ApplicationLicensing            `json:"licensing,omitempty"`
	Name          string                           `json:"name,omitempty"`
	Profile       interface{}                      `json:"profile,omitempty"`
	Settings      *WsFederationApplicationSettings `json:"settings,omitempty"`
	SignOnMode    string                           `json:"signOnMode,omitempty"`
	Status        string                           `json:"status,omitempty"`
	Visibility    *ApplicationVisibility           `json:"visibility,omitempty"`
}

func NewWsFederationApplication 

func NewWsFederationApplication() *WsFederationApplication

func (*WsFederationApplication) IsApplicationInstance 

func (a *WsFederationApplication) IsApplicationInstance() bool

type WsFederationApplicationSettings 

type WsFederationApplicationSettings struct {
	App                *WsFederationApplicationSettingsApplication `json:"app,omitempty"`
	ImplicitAssignment *bool                                       `json:"implicitAssignment,omitempty"`
	InlineHookId       string                                      `json:"inlineHookId,omitempty"`
	Notes              *ApplicationSettingsNotes                   `json:"notes,omitempty"`
	Notifications      *ApplicationSettingsNotifications           `json:"notifications,omitempty"`
}

type WsFederationApplicationSettingsApplication 

type WsFederationApplicationSettingsApplication struct {
	AttributeStatements  string `json:"attributeStatements"`
	AudienceRestriction  string `json:"audienceRestriction,omitempty"`
	AuthnContextClassRef string `json:"authnContextClassRef,omitempty"`
	GroupFilter          string `json:"groupFilter,omitempty"`
	GroupName            string `json:"groupName,omitempty"`
	GroupValueFormat     string `json:"groupValueFormat,omitempty"`
	NameIDFormat         string `json:"nameIDFormat,omitempty"`
	Realm                string `json:"realm,omitempty"`
	SiteURL              string `json:"siteURL,omitempty"`
	UsernameAttribute    string `json:"usernameAttribute,omitempty"`
	WReplyOverride       *bool  `json:"wReplyOverride,omitempty"`
	WReplyURL            string `json:"wReplyURL,omitempty"`
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.