shared

package
v1.22.0 Latest Latest
Warning

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

 Go to latest Published: Nov 8, 2024 License: MIT Imports: 4 Imported by: 3

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AWSExternalID ¶ added in v1.16.0 

type AWSExternalID struct {
	// The externalId field.
	ExternalID *string `json:"externalId,omitempty"`
}

The AWSExternalID message.

func (*AWSExternalID) GetExternalID ¶ added in v1.16.0 

func (o *AWSExternalID) GetExternalID() *string

type Accept ¶ added in v1.10.1 

type Accept struct {
	// An optional message to include in the comments when a task is automatically accepted.
	AcceptMessage *string `json:"acceptMessage,omitempty"`
}

Accept - This policy step indicates that a ticket should have an approved outcome. This is a terminal approval state and is used to explicitly define the end of approval steps.

func (*Accept) GetAcceptMessage ¶ added in v1.18.3 

func (o *Accept) GetAcceptMessage() *string

type AcceptInstance ¶ added in v1.10.1 

type AcceptInstance struct {
	// An optional message to include in the comments when a task is automatically accepted.
	AcceptMessage *string `json:"acceptMessage,omitempty"`
}

AcceptInstance - This policy step indicates that a ticket should have an approved outcome. This is a terminal approval state and is used to explicitly define the end of approval steps. 

The instance is just a marker for it being copied into an active policy.

func (*AcceptInstance) GetAcceptMessage ¶ added in v1.18.3 

func (o *AcceptInstance) GetAcceptMessage() *string

type AccountTypes ¶ added in v1.18.3 

type AccountTypes string
const (
	AccountTypesAppUserTypeUnspecified    AccountTypes = "APP_USER_TYPE_UNSPECIFIED"
	AccountTypesAppUserTypeUser           AccountTypes = "APP_USER_TYPE_USER"
	AccountTypesAppUserTypeServiceAccount AccountTypes = "APP_USER_TYPE_SERVICE_ACCOUNT"
	AccountTypesAppUserTypeSystemAccount  AccountTypes = "APP_USER_TYPE_SYSTEM_ACCOUNT"
)

func (AccountTypes) ToPointer ¶ added in v1.18.3 

func (e AccountTypes) ToPointer() *AccountTypes

func (*AccountTypes) UnmarshalJSON ¶ added in v1.18.3 

func (e *AccountTypes) UnmarshalJSON(data []byte) error

type Actions ¶ added in v1.15.0 

type Actions string
const (
	ActionsTaskActionTypeUnspecified                              Actions = "TASK_ACTION_TYPE_UNSPECIFIED"
	ActionsTaskActionTypeClose                                    Actions = "TASK_ACTION_TYPE_CLOSE"
	ActionsTaskActionTypeApprove                                  Actions = "TASK_ACTION_TYPE_APPROVE"
	ActionsTaskActionTypeDeny                                     Actions = "TASK_ACTION_TYPE_DENY"
	ActionsTaskActionTypeComment                                  Actions = "TASK_ACTION_TYPE_COMMENT"
	ActionsTaskActionTypeDelete                                   Actions = "TASK_ACTION_TYPE_DELETE"
	ActionsTaskActionTypeReassign                                 Actions = "TASK_ACTION_TYPE_REASSIGN"
	ActionsTaskActionTypeRestart                                  Actions = "TASK_ACTION_TYPE_RESTART"
	ActionsTaskActionTypeSendReminder                             Actions = "TASK_ACTION_TYPE_SEND_REMINDER"
	ActionsTaskActionTypeProvisionComplete                        Actions = "TASK_ACTION_TYPE_PROVISION_COMPLETE"
	ActionsTaskActionTypeProvisionCancelled                       Actions = "TASK_ACTION_TYPE_PROVISION_CANCELLED"
	ActionsTaskActionTypeProvisionErrored                         Actions = "TASK_ACTION_TYPE_PROVISION_ERRORED"
	ActionsTaskActionTypeProvisionAppUserTargetCreated            Actions = "TASK_ACTION_TYPE_PROVISION_APP_USER_TARGET_CREATED"
	ActionsTaskActionTypeRollbackSkipped                          Actions = "TASK_ACTION_TYPE_ROLLBACK_SKIPPED"
	ActionsTaskActionTypeHardReset                                Actions = "TASK_ACTION_TYPE_HARD_RESET"
	ActionsTaskActionTypeEscalateToEmergencyAccess                Actions = "TASK_ACTION_TYPE_ESCALATE_TO_EMERGENCY_ACCESS"
	ActionsTaskActionTypeChangePolicy                             Actions = "TASK_ACTION_TYPE_CHANGE_POLICY"
	ActionsTaskActionTypeRecalculateDenialFromBasePolicyDecisions Actions = "TASK_ACTION_TYPE_RECALCULATE_DENIAL_FROM_BASE_POLICY_DECISIONS"
	ActionsTaskActionTypeSetInsightsAndRecommendation             Actions = "TASK_ACTION_TYPE_SET_INSIGHTS_AND_RECOMMENDATION"
	ActionsTaskActionTypeSetAnalysisID                            Actions = "TASK_ACTION_TYPE_SET_ANALYSIS_ID"
	ActionsTaskActionTypeRecalculateApproversList                 Actions = "TASK_ACTION_TYPE_RECALCULATE_APPROVERS_LIST"
	ActionsTaskActionTypeProcessNow                               Actions = "TASK_ACTION_TYPE_PROCESS_NOW"
)

func (Actions) ToPointer ¶ added in v1.15.0 

func (e Actions) ToPointer() *Actions

func (*Actions) UnmarshalJSON ¶ added in v1.15.0 

func (e *Actions) UnmarshalJSON(data []byte) error

type AddAppEntitlementOwnerRequest ¶ added in v1.8.0 

type AddAppEntitlementOwnerRequest struct {
	// The user_id field for the user to add as an owner of the app entitlement.
	UserID *string `json:"userId,omitempty"`
}

AddAppEntitlementOwnerRequest - The request message for adding an app entitlement owner.

func (*AddAppEntitlementOwnerRequest) GetUserID ¶ added in v1.8.0 

func (o *AddAppEntitlementOwnerRequest) GetUserID() *string

type AddAppEntitlementOwnerResponse ¶ added in v1.8.0 

type AddAppEntitlementOwnerResponse struct {
}

AddAppEntitlementOwnerResponse - The empty response message for adding an app entitlement owner.

type AddAppOwnerRequest ¶ added in v1.1.1 

type AddAppOwnerRequest struct {
}

AddAppOwnerRequest - Empty request body. Just placeholder for the add app owner request which uses URL values for input.

type AddAppOwnerResponse ¶ added in v1.1.1 

type AddAppOwnerResponse struct {
}

AddAppOwnerResponse - Empty response with a status code indicating success

type Annotations ¶ added in v1.15.0 

type Annotations struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

Annotations - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*Annotations) GetAdditionalProperties ¶ added in v1.15.0 

func (o *Annotations) GetAdditionalProperties() map[string]any

func (*Annotations) GetAtType ¶ added in v1.15.0 

func (o *Annotations) GetAtType() *string

func (Annotations) MarshalJSON ¶ added in v1.15.0 

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

func (*Annotations) UnmarshalJSON ¶ added in v1.15.0 

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

type App ¶ added in v1.0.3 

type App struct {
	// The ID of the Account named by AccountName.
	AppAccountID *string `json:"appAccountId,omitempty"`
	// The AccountName of the app. For example, AWS is AccountID, Github is Org Name, and Okta is Okta Subdomain.
	AppAccountName *string `json:"appAccountName,omitempty"`
	// The owners of the app.
	AppOwners []User `json:"appOwners,omitempty"`
	// The ID of the Certify Policy associated with this App.
	CertifyPolicyID *string    `json:"certifyPolicyId,omitempty"`
	CreatedAt       *time.Time `json:"createdAt,omitempty"`
	DeletedAt       *time.Time `json:"deletedAt,omitempty"`
	// The app's description.
	Description *string `json:"description,omitempty"`
	// The app's display name.
	DisplayName *string `json:"displayName,omitempty"`
	FieldMask   *string `json:"fieldMask,omitempty"`
	// The ID of the Grant Policy associated with this App.
	GrantPolicyID *string `json:"grantPolicyId,omitempty"`
	// The URL of an icon to display for the app.
	IconURL *string `json:"iconUrl,omitempty"`
	// The ID of the app.
	ID *string `json:"id,omitempty"`
	// The identityMatching field.
	IdentityMatching *IdentityMatching `json:"identityMatching,omitempty"`
	// Specifies if the app is a directory.
	IsDirectory *bool `json:"isDirectory,omitempty"`
	// The isManuallyManaged field.
	IsManuallyManaged *bool `json:"isManuallyManaged,omitempty"`
	// The URL of a logo to display for the app.
	LogoURI *string `json:"logoUri,omitempty"`
	// The cost of an app per-seat, so that total cost can be calculated by the grant count.
	MonthlyCostUsd *int `json:"monthlyCostUsd,omitempty"`
	// The ID of the app that created this app, if any.
	ParentAppID *string `json:"parentAppId,omitempty"`
	// The ID of the Revoke Policy associated with this App.
	RevokePolicyID *string    `json:"revokePolicyId,omitempty"`
	UpdatedAt      *time.Time `json:"updatedAt,omitempty"`
	// The number of users with grants to this app.
	UserCount *int64 `integer:"string" json:"userCount,omitempty"`
}

The App object provides all of the details for an app, as well as some configuration.

func (*App) GetAppAccountID ¶ added in v1.6.1 

func (o *App) GetAppAccountID() *string

func (*App) GetAppAccountName ¶ added in v1.6.1 

func (o *App) GetAppAccountName() *string

func (*App) GetAppOwners ¶ added in v1.18.3 

func (o *App) GetAppOwners() []User

func (*App) GetCertifyPolicyID ¶ added in v1.6.1 

func (o *App) GetCertifyPolicyID() *string

func (*App) GetCreatedAt ¶ added in v1.6.1 

func (o *App) GetCreatedAt() *time.Time

func (*App) GetDeletedAt ¶ added in v1.6.1 

func (o *App) GetDeletedAt() *time.Time

func (*App) GetDescription ¶ added in v1.6.1 

func (o *App) GetDescription() *string

func (*App) GetDisplayName ¶ added in v1.6.1 

func (o *App) GetDisplayName() *string

func (*App) GetFieldMask ¶ added in v1.6.1 

func (o *App) GetFieldMask() *string

func (*App) GetGrantPolicyID ¶ added in v1.6.1 

func (o *App) GetGrantPolicyID() *string

func (*App) GetID ¶ added in v1.6.1 

func (o *App) GetID() *string

func (*App) GetIconURL ¶ added in v1.6.1 

func (o *App) GetIconURL() *string

func (*App) GetIdentityMatching ¶ added in v1.18.3 

func (o *App) GetIdentityMatching() *IdentityMatching

func (*App) GetIsDirectory ¶ added in v1.15.0 

func (o *App) GetIsDirectory() *bool

func (*App) GetIsManuallyManaged ¶ added in v1.21.3 

func (o *App) GetIsManuallyManaged() *bool

func (*App) GetLogoURI ¶ added in v1.6.1 

func (o *App) GetLogoURI() *string

func (*App) GetMonthlyCostUsd ¶ added in v1.6.1 

func (o *App) GetMonthlyCostUsd() *int

func (*App) GetParentAppID ¶ added in v1.6.1 

func (o *App) GetParentAppID() *string

func (*App) GetRevokePolicyID ¶ added in v1.6.1 

func (o *App) GetRevokePolicyID() *string

func (*App) GetUpdatedAt ¶ added in v1.6.1 

func (o *App) GetUpdatedAt() *time.Time

func (*App) GetUserCount ¶ added in v1.6.1 

func (o *App) GetUserCount() *int64

func (App) MarshalJSON ¶ added in v1.10.1 

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

func (*App) UnmarshalJSON ¶ added in v1.10.1 

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

type AppAccessRequestDefaults ¶ added in v1.18.3 

type AppAccessRequestDefaults struct {
	// The app id for the app access request rule
	AppID *string `json:"appId,omitempty"`
	// The request catalog ids for the app access request rule.
	CatalogIds []string `json:"catalogIds,omitempty"`
	// If true the app level request configuration will be applied to specified resource types.
	DefaultsEnabled *bool          `json:"defaultsEnabled,omitempty"`
	DurationGrant   *string        `json:"durationGrant,omitempty"`
	DurationUnset   *DurationUnset `json:"durationUnset,omitempty"`
	// If emergency grants are enabled for this app access request rule.
	EmergencyGrantEnabled *bool `json:"emergencyGrantEnabled,omitempty"`
	// The policy id for the emergency grant policy.
	EmergencyGrantPolicyID *string `json:"emergencyGrantPolicyId,omitempty"`
	// The requestPolicyId field.
	RequestPolicyID *string `json:"requestPolicyId,omitempty"`
	// The app resource type ids for which the app access request defaults are applied.
	ResourceTypeIds []string `json:"resourceTypeIds,omitempty"`
	// The last applied state of the app access request defaults.
	State *State `json:"state,omitempty"`
}

The AppAccessRequestDefaults message.

This message contains a oneof named max_grant_duration. Only a single field of the following list may be set at a time:

  • durationUnset
  • durationGrant

func (*AppAccessRequestDefaults) GetAppID ¶ added in v1.18.3 

func (o *AppAccessRequestDefaults) GetAppID() *string

func (*AppAccessRequestDefaults) GetCatalogIds ¶ added in v1.18.3 

func (o *AppAccessRequestDefaults) GetCatalogIds() []string

func (*AppAccessRequestDefaults) GetDefaultsEnabled ¶ added in v1.18.3 

func (o *AppAccessRequestDefaults) GetDefaultsEnabled() *bool

func (*AppAccessRequestDefaults) GetDurationGrant ¶ added in v1.18.3 

func (o *AppAccessRequestDefaults) GetDurationGrant() *string

func (*AppAccessRequestDefaults) GetDurationUnset ¶ added in v1.18.3 

func (o *AppAccessRequestDefaults) GetDurationUnset() *DurationUnset

func (*AppAccessRequestDefaults) GetEmergencyGrantEnabled ¶ added in v1.18.3 

func (o *AppAccessRequestDefaults) GetEmergencyGrantEnabled() *bool

func (*AppAccessRequestDefaults) GetEmergencyGrantPolicyID ¶ added in v1.18.3 

func (o *AppAccessRequestDefaults) GetEmergencyGrantPolicyID() *string

func (*AppAccessRequestDefaults) GetRequestPolicyID ¶ added in v1.18.3 

func (o *AppAccessRequestDefaults) GetRequestPolicyID() *string

func (*AppAccessRequestDefaults) GetResourceTypeIds ¶ added in v1.18.3 

func (o *AppAccessRequestDefaults) GetResourceTypeIds() []string

func (*AppAccessRequestDefaults) GetState ¶ added in v1.18.3 

func (o *AppAccessRequestDefaults) GetState() *State

type AppAccessRequestDefaults1 ¶ added in v1.18.3 

type AppAccessRequestDefaults1 struct {
	// The request catalog ids for the app access request rule.
	CatalogIds []string `json:"catalogIds,omitempty"`
	// If true the app level request configuration will be applied to specified resource types.
	DefaultsEnabled *bool          `json:"defaultsEnabled,omitempty"`
	DurationGrant   *string        `json:"durationGrant,omitempty"`
	DurationUnset   *DurationUnset `json:"durationUnset,omitempty"`
	// If emergency grants are enabled for this app access request rule.
	EmergencyGrantEnabled *bool `json:"emergencyGrantEnabled,omitempty"`
	// The policy id for the emergency grant policy.
	EmergencyGrantPolicyID *string `json:"emergencyGrantPolicyId,omitempty"`
	// The requestPolicyId field.
	RequestPolicyID *string `json:"requestPolicyId,omitempty"`
	// The app resource type ids for which the app access request defaults are applied.
	ResourceTypeIds []string `json:"resourceTypeIds,omitempty"`
	// The last applied state of the app access request defaults.
	State *State `json:"state,omitempty"`
}

AppAccessRequestDefaults1 - The AppAccessRequestDefaults message.

This message contains a oneof named max_grant_duration. Only a single field of the following list may be set at a time:

  • durationUnset
  • durationGrant

func (*AppAccessRequestDefaults1) GetCatalogIds ¶ added in v1.18.3 

func (o *AppAccessRequestDefaults1) GetCatalogIds() []string

func (*AppAccessRequestDefaults1) GetDefaultsEnabled ¶ added in v1.18.3 

func (o *AppAccessRequestDefaults1) GetDefaultsEnabled() *bool

func (*AppAccessRequestDefaults1) GetDurationGrant ¶ added in v1.18.3 

func (o *AppAccessRequestDefaults1) GetDurationGrant() *string

func (*AppAccessRequestDefaults1) GetDurationUnset ¶ added in v1.18.3 

func (o *AppAccessRequestDefaults1) GetDurationUnset() *DurationUnset

func (*AppAccessRequestDefaults1) GetEmergencyGrantEnabled ¶ added in v1.18.3 

func (o *AppAccessRequestDefaults1) GetEmergencyGrantEnabled() *bool

func (*AppAccessRequestDefaults1) GetEmergencyGrantPolicyID ¶ added in v1.18.3 

func (o *AppAccessRequestDefaults1) GetEmergencyGrantPolicyID() *string

func (*AppAccessRequestDefaults1) GetRequestPolicyID ¶ added in v1.18.3 

func (o *AppAccessRequestDefaults1) GetRequestPolicyID() *string

func (*AppAccessRequestDefaults1) GetResourceTypeIds ¶ added in v1.18.3 

func (o *AppAccessRequestDefaults1) GetResourceTypeIds() []string

func (*AppAccessRequestDefaults1) GetState ¶ added in v1.18.3 

func (o *AppAccessRequestDefaults1) GetState() *State

type AppActionsServiceGenerateReportRequest ¶ added in v1.0.3 

type AppActionsServiceGenerateReportRequest struct {
}

AppActionsServiceGenerateReportRequest - Empty request body. Just placeholder for the generate app report request which uses URL values for input.

type AppActionsServiceGenerateReportResponse ¶ added in v1.0.3 

type AppActionsServiceGenerateReportResponse struct {
}

AppActionsServiceGenerateReportResponse - Empty response body. Status code indicates success.

type AppEntitlement ¶ added in v1.0.3 

type AppEntitlement struct {
	// ProvisionPolicy is a oneOf that indicates how a provision step should be processed.
	//
	// This message contains a oneof named typ. Only a single field of the following list may be set at a time:
	//   - connector
	//   - manual
	//   - delegated
	//   - webhook
	//   - multiStep
	//   - externalTicket
	//
	ProvisionPolicy *ProvisionPolicy `json:"provisionerPolicy,omitempty"`
	// The alias of the app entitlement used by Cone. Also exact-match queryable.
	Alias *string `json:"alias,omitempty"`
	// The ID of the app that is associated with the app entitlement.
	AppID *string `json:"appId,omitempty"`
	// The ID of the app resource that is associated with the app entitlement
	AppResourceID *string `json:"appResourceId,omitempty"`
	// The ID of the app resource type that is associated with the app entitlement
	AppResourceTypeID *string `json:"appResourceTypeId,omitempty"`
	// The ID of the policy that will be used for certify tickets related to the app entitlement.
	CertifyPolicyID *string `json:"certifyPolicyId,omitempty"`
	// The IDs of different compliance frameworks associated with this app entitlement ex (SOX, HIPAA, PCI, etc.)
	ComplianceFrameworkValueIds []string   `json:"complianceFrameworkValueIds,omitempty"`
	CreatedAt                   *time.Time `json:"createdAt,omitempty"`
	// Flag to indicate if app-level access request defaults have been applied to the entitlement
	DefaultValuesApplied *bool      `json:"defaultValuesApplied,omitempty"`
	DeletedAt            *time.Time `json:"deletedAt,omitempty"`
	// The description of the app entitlement.
	Description *string `json:"description,omitempty"`
	// The display name of the app entitlement.
	DisplayName   *string                      `json:"displayName,omitempty"`
	DurationGrant *string                      `json:"durationGrant,omitempty"`
	DurationUnset *AppEntitlementDurationUnset `json:"durationUnset,omitempty"`
	// This enables tasks to be created in an emergency and use a selected emergency access policy.
	EmergencyGrantEnabled *bool `json:"emergencyGrantEnabled,omitempty"`
	// The ID of the policy that will be used for emergency access grant tasks.
	EmergencyGrantPolicyID *string `json:"emergencyGrantPolicyId,omitempty"`
	// The amount of grants open for this entitlement
	GrantCount *int64 `integer:"string" json:"grantCount,omitempty"`
	// The ID of the policy that will be used for grant tickets related to the app entitlement.
	GrantPolicyID *string `json:"grantPolicyId,omitempty"`
	// The unique ID for the App Entitlement.
	ID *string `json:"id,omitempty"`
	// Flag to indicate whether automation (for adding users to entitlement based on rules) has been enabled.
	IsAutomationEnabled *bool `json:"isAutomationEnabled,omitempty"`
	// Flag to indicate if the app entitlement is manually managed.
	IsManuallyManaged *bool `json:"isManuallyManaged,omitempty"`
	// Flag to indicate if the app-level access request settings have been overridden for the entitlement
	OverrideAccessRequestsDefaults *bool `json:"overrideAccessRequestsDefaults,omitempty"`
	// The purpose field.
	Purpose *Purpose `json:"purpose,omitempty"`
	// The ID of the policy that will be used for revoke tickets related to the app entitlement
	RevokePolicyID *string `json:"revokePolicyId,omitempty"`
	// The riskLevelValueId field.
	RiskLevelValueID *string `json:"riskLevelValueId,omitempty"`
	// The slug is displayed as an oval next to the name in the frontend of C1, it tells you what permission the entitlement grants. See https://www.conductorone.com/docs/product/manage-access/entitlements/
	Slug *string `json:"slug,omitempty"`
	// Map to tell us which connector the entitlement came from.
	SourceConnectorIds map[string]string `json:"sourceConnectorIds,omitempty"`
	// This field indicates if this is a system builtin entitlement.
	SystemBuiltin  *bool      `json:"systemBuiltin,omitempty"`
	UpdatedAt      *time.Time `json:"updatedAt,omitempty"`
	UserEditedMask *string    `json:"userEditedMask,omitempty"`
}

AppEntitlement - The app entitlement represents one permission in a downstream App (SAAS) that can be granted. For example, GitHub Read vs GitHub Write.

This message contains a oneof named max_grant_duration. Only a single field of the following list may be set at a time:

  • durationUnset
  • durationGrant

func (*AppEntitlement) GetAlias ¶ added in v1.6.1 

func (o *AppEntitlement) GetAlias() *string

func (*AppEntitlement) GetAppID ¶ added in v1.6.1 

func (o *AppEntitlement) GetAppID() *string

func (*AppEntitlement) GetAppResourceID ¶ added in v1.6.1 

func (o *AppEntitlement) GetAppResourceID() *string

func (*AppEntitlement) GetAppResourceTypeID ¶ added in v1.6.1 

func (o *AppEntitlement) GetAppResourceTypeID() *string

func (*AppEntitlement) GetCertifyPolicyID ¶ added in v1.6.1 

func (o *AppEntitlement) GetCertifyPolicyID() *string

func (*AppEntitlement) GetComplianceFrameworkValueIds ¶ added in v1.6.1 

func (o *AppEntitlement) GetComplianceFrameworkValueIds() []string

func (*AppEntitlement) GetCreatedAt ¶ added in v1.6.1 

func (o *AppEntitlement) GetCreatedAt() *time.Time

func (*AppEntitlement) GetDefaultValuesApplied ¶ added in v1.18.3 

func (o *AppEntitlement) GetDefaultValuesApplied() *bool

func (*AppEntitlement) GetDeletedAt ¶ added in v1.6.1 

func (o *AppEntitlement) GetDeletedAt() *time.Time

func (*AppEntitlement) GetDescription ¶ added in v1.6.1 

func (o *AppEntitlement) GetDescription() *string

func (*AppEntitlement) GetDisplayName ¶ added in v1.6.1 

func (o *AppEntitlement) GetDisplayName() *string

func (*AppEntitlement) GetDurationGrant ¶ added in v1.6.1 

func (o *AppEntitlement) GetDurationGrant() *string

func (*AppEntitlement) GetDurationUnset ¶ added in v1.6.1 

func (o *AppEntitlement) GetDurationUnset() *AppEntitlementDurationUnset

func (*AppEntitlement) GetEmergencyGrantEnabled ¶ added in v1.6.1 

func (o *AppEntitlement) GetEmergencyGrantEnabled() *bool

func (*AppEntitlement) GetEmergencyGrantPolicyID ¶ added in v1.6.1 

func (o *AppEntitlement) GetEmergencyGrantPolicyID() *string

func (*AppEntitlement) GetGrantCount ¶ added in v1.6.1 

func (o *AppEntitlement) GetGrantCount() *int64

func (*AppEntitlement) GetGrantPolicyID ¶ added in v1.6.1 

func (o *AppEntitlement) GetGrantPolicyID() *string

func (*AppEntitlement) GetID ¶ added in v1.6.1 

func (o *AppEntitlement) GetID() *string

func (*AppEntitlement) GetIsAutomationEnabled ¶ added in v1.18.3 

func (o *AppEntitlement) GetIsAutomationEnabled() *bool

func (*AppEntitlement) GetIsManuallyManaged ¶ added in v1.18.3 

func (o *AppEntitlement) GetIsManuallyManaged() *bool

func (*AppEntitlement) GetOverrideAccessRequestsDefaults ¶ added in v1.18.3 

func (o *AppEntitlement) GetOverrideAccessRequestsDefaults() *bool

func (*AppEntitlement) GetProvisionPolicy ¶ added in v1.6.1 

func (o *AppEntitlement) GetProvisionPolicy() *ProvisionPolicy

func (*AppEntitlement) GetPurpose ¶ added in v1.21.4 

func (o *AppEntitlement) GetPurpose() *Purpose

func (*AppEntitlement) GetRevokePolicyID ¶ added in v1.6.1 

func (o *AppEntitlement) GetRevokePolicyID() *string

func (*AppEntitlement) GetRiskLevelValueID ¶ added in v1.6.1 

func (o *AppEntitlement) GetRiskLevelValueID() *string

func (*AppEntitlement) GetSlug ¶ added in v1.6.1 

func (o *AppEntitlement) GetSlug() *string

func (*AppEntitlement) GetSourceConnectorIds ¶ added in v1.18.3 

func (o *AppEntitlement) GetSourceConnectorIds() map[string]string

func (*AppEntitlement) GetSystemBuiltin ¶ added in v1.6.1 

func (o *AppEntitlement) GetSystemBuiltin() *bool

func (*AppEntitlement) GetUpdatedAt ¶ added in v1.6.1 

func (o *AppEntitlement) GetUpdatedAt() *time.Time

func (*AppEntitlement) GetUserEditedMask ¶ added in v1.15.0 

func (o *AppEntitlement) GetUserEditedMask() *string

func (AppEntitlement) MarshalJSON ¶ added in v1.10.1 

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

func (*AppEntitlement) UnmarshalJSON ¶ added in v1.10.1 

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

type AppEntitlementDurationUnset ¶ added in v1.0.3 

type AppEntitlementDurationUnset struct {
}

type AppEntitlementExpandMask ¶ added in v1.0.3 

type AppEntitlementExpandMask struct {
	// Array of strings to describe which items to expand on the return value. Can be any combination of "*", "app_id", "app_resource_type_id", or "app_resource_id".
	Paths []string `json:"paths,omitempty"`
}

AppEntitlementExpandMask - The app entitlement expand mask allows the user to get additional information when getting responses containing app entitlement views.

func (*AppEntitlementExpandMask) GetPaths ¶ added in v1.6.1 

func (o *AppEntitlementExpandMask) GetPaths() []string

type AppEntitlementInput ¶ added in v1.7.0 

type AppEntitlementInput struct {
	// ProvisionPolicy is a oneOf that indicates how a provision step should be processed.
	//
	// This message contains a oneof named typ. Only a single field of the following list may be set at a time:
	//   - connector
	//   - manual
	//   - delegated
	//   - webhook
	//   - multiStep
	//   - externalTicket
	//
	ProvisionPolicy *ProvisionPolicyInput `json:"provisionerPolicy,omitempty"`
	// The alias of the app entitlement used by Cone. Also exact-match queryable.
	Alias *string `json:"alias,omitempty"`
	// The ID of the app that is associated with the app entitlement.
	AppID *string `json:"appId,omitempty"`
	// The ID of the app resource that is associated with the app entitlement
	AppResourceID *string `json:"appResourceId,omitempty"`
	// The ID of the app resource type that is associated with the app entitlement
	AppResourceTypeID *string `json:"appResourceTypeId,omitempty"`
	// The ID of the policy that will be used for certify tickets related to the app entitlement.
	CertifyPolicyID *string `json:"certifyPolicyId,omitempty"`
	// The IDs of different compliance frameworks associated with this app entitlement ex (SOX, HIPAA, PCI, etc.)
	ComplianceFrameworkValueIds []string `json:"complianceFrameworkValueIds,omitempty"`
	// Flag to indicate if app-level access request defaults have been applied to the entitlement
	DefaultValuesApplied *bool `json:"defaultValuesApplied,omitempty"`
	// The description of the app entitlement.
	Description *string `json:"description,omitempty"`
	// The display name of the app entitlement.
	DisplayName   *string                      `json:"displayName,omitempty"`
	DurationGrant *string                      `json:"durationGrant,omitempty"`
	DurationUnset *AppEntitlementDurationUnset `json:"durationUnset,omitempty"`
	// This enables tasks to be created in an emergency and use a selected emergency access policy.
	EmergencyGrantEnabled *bool `json:"emergencyGrantEnabled,omitempty"`
	// The ID of the policy that will be used for emergency access grant tasks.
	EmergencyGrantPolicyID *string `json:"emergencyGrantPolicyId,omitempty"`
	// The ID of the policy that will be used for grant tickets related to the app entitlement.
	GrantPolicyID *string `json:"grantPolicyId,omitempty"`
	// Flag to indicate if the app entitlement is manually managed.
	IsManuallyManaged *bool `json:"isManuallyManaged,omitempty"`
	// Flag to indicate if the app-level access request settings have been overridden for the entitlement
	OverrideAccessRequestsDefaults *bool `json:"overrideAccessRequestsDefaults,omitempty"`
	// The purpose field.
	Purpose *Purpose `json:"purpose,omitempty"`
	// The ID of the policy that will be used for revoke tickets related to the app entitlement
	RevokePolicyID *string `json:"revokePolicyId,omitempty"`
	// The riskLevelValueId field.
	RiskLevelValueID *string `json:"riskLevelValueId,omitempty"`
	// The slug is displayed as an oval next to the name in the frontend of C1, it tells you what permission the entitlement grants. See https://www.conductorone.com/docs/product/manage-access/entitlements/
	Slug *string `json:"slug,omitempty"`
	// Map to tell us which connector the entitlement came from.
	SourceConnectorIds map[string]string `json:"sourceConnectorIds,omitempty"`
	UserEditedMask     *string           `json:"userEditedMask,omitempty"`
}

AppEntitlementInput - The app entitlement represents one permission in a downstream App (SAAS) that can be granted. For example, GitHub Read vs GitHub Write.

This message contains a oneof named max_grant_duration. Only a single field of the following list may be set at a time:

  • durationUnset
  • durationGrant

func (*AppEntitlementInput) GetAlias ¶ added in v1.7.0 

func (o *AppEntitlementInput) GetAlias() *string

func (*AppEntitlementInput) GetAppID ¶ added in v1.7.0 

func (o *AppEntitlementInput) GetAppID() *string

func (*AppEntitlementInput) GetAppResourceID ¶ added in v1.7.0 

func (o *AppEntitlementInput) GetAppResourceID() *string

func (*AppEntitlementInput) GetAppResourceTypeID ¶ added in v1.7.0 

func (o *AppEntitlementInput) GetAppResourceTypeID() *string

func (*AppEntitlementInput) GetCertifyPolicyID ¶ added in v1.7.0 

func (o *AppEntitlementInput) GetCertifyPolicyID() *string

func (*AppEntitlementInput) GetComplianceFrameworkValueIds ¶ added in v1.7.0 

func (o *AppEntitlementInput) GetComplianceFrameworkValueIds() []string

func (*AppEntitlementInput) GetDefaultValuesApplied ¶ added in v1.18.3 

func (o *AppEntitlementInput) GetDefaultValuesApplied() *bool

func (*AppEntitlementInput) GetDescription ¶ added in v1.7.0 

func (o *AppEntitlementInput) GetDescription() *string

func (*AppEntitlementInput) GetDisplayName ¶ added in v1.7.0 

func (o *AppEntitlementInput) GetDisplayName() *string

func (*AppEntitlementInput) GetDurationGrant ¶ added in v1.7.0 

func (o *AppEntitlementInput) GetDurationGrant() *string

func (*AppEntitlementInput) GetDurationUnset ¶ added in v1.7.0 

func (o *AppEntitlementInput) GetDurationUnset() *AppEntitlementDurationUnset

func (*AppEntitlementInput) GetEmergencyGrantEnabled ¶ added in v1.7.0 

func (o *AppEntitlementInput) GetEmergencyGrantEnabled() *bool

func (*AppEntitlementInput) GetEmergencyGrantPolicyID ¶ added in v1.7.0 

func (o *AppEntitlementInput) GetEmergencyGrantPolicyID() *string

func (*AppEntitlementInput) GetGrantPolicyID ¶ added in v1.7.0 

func (o *AppEntitlementInput) GetGrantPolicyID() *string

func (*AppEntitlementInput) GetIsManuallyManaged ¶ added in v1.18.3 

func (o *AppEntitlementInput) GetIsManuallyManaged() *bool

func (*AppEntitlementInput) GetOverrideAccessRequestsDefaults ¶ added in v1.18.3 

func (o *AppEntitlementInput) GetOverrideAccessRequestsDefaults() *bool

func (*AppEntitlementInput) GetProvisionPolicy ¶ added in v1.7.0 

func (o *AppEntitlementInput) GetProvisionPolicy() *ProvisionPolicyInput

func (*AppEntitlementInput) GetPurpose ¶ added in v1.21.4 

func (o *AppEntitlementInput) GetPurpose() *Purpose

func (*AppEntitlementInput) GetRevokePolicyID ¶ added in v1.7.0 

func (o *AppEntitlementInput) GetRevokePolicyID() *string

func (*AppEntitlementInput) GetRiskLevelValueID ¶ added in v1.7.0 

func (o *AppEntitlementInput) GetRiskLevelValueID() *string

func (*AppEntitlementInput) GetSlug ¶ added in v1.7.0 

func (o *AppEntitlementInput) GetSlug() *string

func (*AppEntitlementInput) GetSourceConnectorIds ¶ added in v1.18.3 

func (o *AppEntitlementInput) GetSourceConnectorIds() map[string]string

func (*AppEntitlementInput) GetUserEditedMask ¶ added in v1.15.0 

func (o *AppEntitlementInput) GetUserEditedMask() *string

type AppEntitlementProxy ¶ added in v1.21.3 

type AppEntitlementProxy struct {
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
	// The dstAppEntitlementId field.
	DstAppEntitlementID *string `json:"dstAppEntitlementId,omitempty"`
	// The dstAppId field.
	DstAppID *string `json:"dstAppId,omitempty"`
	// If true, the binding doesn't not exist yet and is from the list of the entitlements from the parent app.
	//  typically the IdP that handles provisioning for the app instead of C1s connector.
	// This field is part of the `_implicit` oneof.
	// See the documentation for `c1.api.app.v1.AppEntitlementProxy` for more details.
	Implicit *bool `json:"implicit,omitempty"`
	// The srcAppEntitlementId field.
	SrcAppEntitlementID *string `json:"srcAppEntitlementId,omitempty"`
	// The srcAppId field.
	SrcAppID *string `json:"srcAppId,omitempty"`
	// The systemBuiltin field.
	SystemBuiltin *bool      `json:"systemBuiltin,omitempty"`
	UpdatedAt     *time.Time `json:"updatedAt,omitempty"`
}

The AppEntitlementProxy message.

This message contains a oneof named _implicit. Only a single field of the following list may be set at a time:

  • implicit

func (*AppEntitlementProxy) GetCreatedAt ¶ added in v1.21.3 

func (o *AppEntitlementProxy) GetCreatedAt() *time.Time

func (*AppEntitlementProxy) GetDeletedAt ¶ added in v1.21.3 

func (o *AppEntitlementProxy) GetDeletedAt() *time.Time

func (*AppEntitlementProxy) GetDstAppEntitlementID ¶ added in v1.21.3 

func (o *AppEntitlementProxy) GetDstAppEntitlementID() *string

func (*AppEntitlementProxy) GetDstAppID ¶ added in v1.21.3 

func (o *AppEntitlementProxy) GetDstAppID() *string

func (*AppEntitlementProxy) GetImplicit ¶ added in v1.21.3 

func (o *AppEntitlementProxy) GetImplicit() *bool

func (*AppEntitlementProxy) GetSrcAppEntitlementID ¶ added in v1.21.3 

func (o *AppEntitlementProxy) GetSrcAppEntitlementID() *string

func (*AppEntitlementProxy) GetSrcAppID ¶ added in v1.21.3 

func (o *AppEntitlementProxy) GetSrcAppID() *string

func (*AppEntitlementProxy) GetSystemBuiltin ¶ added in v1.21.3 

func (o *AppEntitlementProxy) GetSystemBuiltin() *bool

func (*AppEntitlementProxy) GetUpdatedAt ¶ added in v1.21.3 

func (o *AppEntitlementProxy) GetUpdatedAt() *time.Time

func (AppEntitlementProxy) MarshalJSON ¶ added in v1.21.3 

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

func (*AppEntitlementProxy) UnmarshalJSON ¶ added in v1.21.3 

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

type AppEntitlementProxyExpandMask ¶ added in v1.21.3 

type AppEntitlementProxyExpandMask struct {
	// The paths field.
	Paths []string `json:"paths,omitempty"`
}

The AppEntitlementProxyExpandMask message.

func (*AppEntitlementProxyExpandMask) GetPaths ¶ added in v1.21.3 

func (o *AppEntitlementProxyExpandMask) GetPaths() []string

type AppEntitlementProxyView ¶ added in v1.21.3 

type AppEntitlementProxyView struct {
	// The AppEntitlementProxy message.
	//
	// This message contains a oneof named _implicit. Only a single field of the following list may be set at a time:
	//   - implicit
	//
	AppEntitlementProxy *AppEntitlementProxy `json:"appProxyEntitlement,omitempty"`
	// The dstAppEntitlementPath field.
	DstAppEntitlementPath *string `json:"dstAppEntitlementPath,omitempty"`
	// The dstAppPath field.
	DstAppPath *string `json:"dstAppPath,omitempty"`
	// The srcAppEntitlementPath field.
	SrcAppEntitlementPath *string `json:"srcAppEntitlementPath,omitempty"`
	// The srcAppPath field.
	SrcAppPath *string `json:"srcAppPath,omitempty"`
}

The AppEntitlementProxyView message.

func (*AppEntitlementProxyView) GetAppEntitlementProxy ¶ added in v1.21.3 

func (o *AppEntitlementProxyView) GetAppEntitlementProxy() *AppEntitlementProxy

func (*AppEntitlementProxyView) GetDstAppEntitlementPath ¶ added in v1.21.3 

func (o *AppEntitlementProxyView) GetDstAppEntitlementPath() *string

func (*AppEntitlementProxyView) GetDstAppPath ¶ added in v1.21.3 

func (o *AppEntitlementProxyView) GetDstAppPath() *string

func (*AppEntitlementProxyView) GetSrcAppEntitlementPath ¶ added in v1.21.3 

func (o *AppEntitlementProxyView) GetSrcAppEntitlementPath() *string

func (*AppEntitlementProxyView) GetSrcAppPath ¶ added in v1.21.3 

func (o *AppEntitlementProxyView) GetSrcAppPath() *string

type AppEntitlementRef ¶ added in v1.6.1 

type AppEntitlementRef struct {
	// The appId field.
	AppID *string `json:"appId,omitempty"`
	// The id field.
	ID *string `json:"id,omitempty"`
}

The AppEntitlementRef message.

func (*AppEntitlementRef) GetAppID ¶ added in v1.6.1 

func (o *AppEntitlementRef) GetAppID() *string

func (*AppEntitlementRef) GetID ¶ added in v1.6.1 

func (o *AppEntitlementRef) GetID() *string

type AppEntitlementReference ¶ added in v1.0.3 

type AppEntitlementReference struct {
	// The ID of the Entitlement.
	AppEntitlementID *string `json:"appEntitlementId,omitempty"`
	// The ID of the App this entitlement belongs to.
	AppID *string `json:"appId,omitempty"`
}

AppEntitlementReference - This object references an app entitlement's ID and AppID.

func (*AppEntitlementReference) GetAppEntitlementID ¶ added in v1.6.1 

func (o *AppEntitlementReference) GetAppEntitlementID() *string

func (*AppEntitlementReference) GetAppID ¶ added in v1.6.1 

func (o *AppEntitlementReference) GetAppID() *string

type AppEntitlementSearchServiceSearchRequest ¶ added in v1.7.0 

type AppEntitlementSearchServiceSearchRequest struct {
	// The app entitlement expand mask allows the user to get additional information when getting responses containing app entitlement views.
	AppEntitlementExpandMask *AppEntitlementExpandMask `json:"expandMask,omitempty"`
	// Search for app entitlements that are being reviewed as part of this access review campaign.
	AccessReviewID *string `json:"accessReviewId,omitempty"`
	// Search for app entitlements that have this alias (exact match).
	Alias *string `json:"alias,omitempty"`
	// Search for app entitlements contained in any of these apps.
	AppIds []string `json:"appIds,omitempty"`
	// Search for app entitlements that are granted to any of these app user ids.
	AppUserIds []string `json:"appUserIds,omitempty"`
	// Search for app entitlements that are part of these compliace frameworks.
	ComplianceFrameworkIds []string `json:"complianceFrameworkIds,omitempty"`
	// Exclude app entitlements from the results that are in these app IDs.
	ExcludeAppIds []string `json:"excludeAppIds,omitempty"`
	// Exclude app entitlements from the results that these app users have granted.
	ExcludeAppUserIds []string `json:"excludeAppUserIds,omitempty"`
	// The excludeResourceTypeIds field.
	ExcludeResourceTypeIds []string `json:"excludeResourceTypeIds,omitempty"`
	// Include deleted app entitlements, this includes app entitlements that have a deleted parent object (app, app resource, app resource type)
	IncludeDeleted *bool `json:"includeDeleted,omitempty"`
	// The isAutomated field.
	IsAutomated *bool `json:"isAutomated,omitempty"`
	// The membershipType field.
	MembershipType []MembershipType `json:"membershipType,omitempty"`
	// Restrict results to only those who have expiring app entitlement user bindings.
	OnlyGetExpiring *bool `json:"onlyGetExpiring,omitempty"`
	// The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)
	PageSize *int `json:"pageSize,omitempty"`
	// The pageToken field.
	PageToken *string `json:"pageToken,omitempty"`
	// Query the app entitlements with a fuzzy search on display name and description.
	Query *string `json:"query,omitempty"`
	// The refs field.
	Refs []AppEntitlementRef `json:"refs,omitempty"`
	// Search for app entitlements that belongs to these resources.
	ResourceIds []string `json:"resourceIds,omitempty"`
	// The resourceTraitIds field.
	ResourceTraitIds []string `json:"resourceTraitIds,omitempty"`
	// Search for app entitlements that are for items with resources types that have matching names. Example names are "group", "role", and "app".
	ResourceTypeIds []string `json:"resourceTypeIds,omitempty"`
	// Search for app entitlements with these risk levels.
	RiskLevelIds []string `json:"riskLevelIds,omitempty"`
}

AppEntitlementSearchServiceSearchRequest - Search app entitlements by a variety of filters.

func (*AppEntitlementSearchServiceSearchRequest) GetAccessReviewID ¶ added in v1.7.0 

func (o *AppEntitlementSearchServiceSearchRequest) GetAccessReviewID() *string

func (*AppEntitlementSearchServiceSearchRequest) GetAlias ¶ added in v1.7.0 

func (o *AppEntitlementSearchServiceSearchRequest) GetAlias() *string

func (*AppEntitlementSearchServiceSearchRequest) GetAppEntitlementExpandMask ¶ added in v1.7.0 

func (o *AppEntitlementSearchServiceSearchRequest) GetAppEntitlementExpandMask() *AppEntitlementExpandMask

func (*AppEntitlementSearchServiceSearchRequest) GetAppIds ¶ added in v1.7.0 

func (o *AppEntitlementSearchServiceSearchRequest) GetAppIds() []string

func (*AppEntitlementSearchServiceSearchRequest) GetAppUserIds ¶ added in v1.7.0 

func (o *AppEntitlementSearchServiceSearchRequest) GetAppUserIds() []string

func (*AppEntitlementSearchServiceSearchRequest) GetComplianceFrameworkIds ¶ added in v1.7.0 

func (o *AppEntitlementSearchServiceSearchRequest) GetComplianceFrameworkIds() []string

func (*AppEntitlementSearchServiceSearchRequest) GetExcludeAppIds ¶ added in v1.7.0 

func (o *AppEntitlementSearchServiceSearchRequest) GetExcludeAppIds() []string

func (*AppEntitlementSearchServiceSearchRequest) GetExcludeAppUserIds ¶ added in v1.7.0 

func (o *AppEntitlementSearchServiceSearchRequest) GetExcludeAppUserIds() []string

func (*AppEntitlementSearchServiceSearchRequest) GetExcludeResourceTypeIds ¶ added in v1.20.0 

func (o *AppEntitlementSearchServiceSearchRequest) GetExcludeResourceTypeIds() []string

func (*AppEntitlementSearchServiceSearchRequest) GetIncludeDeleted ¶ added in v1.9.0 

func (o *AppEntitlementSearchServiceSearchRequest) GetIncludeDeleted() *bool

func (*AppEntitlementSearchServiceSearchRequest) GetIsAutomated ¶ added in v1.18.3 

func (o *AppEntitlementSearchServiceSearchRequest) GetIsAutomated() *bool

func (*AppEntitlementSearchServiceSearchRequest) GetMembershipType ¶ added in v1.20.0 

func (o *AppEntitlementSearchServiceSearchRequest) GetMembershipType() []MembershipType

func (*AppEntitlementSearchServiceSearchRequest) GetOnlyGetExpiring ¶ added in v1.7.0 

func (o *AppEntitlementSearchServiceSearchRequest) GetOnlyGetExpiring() *bool

func (*AppEntitlementSearchServiceSearchRequest) GetPageSize ¶ added in v1.7.0 

func (o *AppEntitlementSearchServiceSearchRequest) GetPageSize() *int

func (*AppEntitlementSearchServiceSearchRequest) GetPageToken ¶ added in v1.7.0 

func (o *AppEntitlementSearchServiceSearchRequest) GetPageToken() *string

func (*AppEntitlementSearchServiceSearchRequest) GetQuery ¶ added in v1.7.0 

func (o *AppEntitlementSearchServiceSearchRequest) GetQuery() *string

func (*AppEntitlementSearchServiceSearchRequest) GetRefs ¶ added in v1.18.3 

func (o *AppEntitlementSearchServiceSearchRequest) GetRefs() []AppEntitlementRef

func (*AppEntitlementSearchServiceSearchRequest) GetResourceIds ¶ added in v1.16.0 

func (o *AppEntitlementSearchServiceSearchRequest) GetResourceIds() []string

func (*AppEntitlementSearchServiceSearchRequest) GetResourceTraitIds ¶ added in v1.18.3 

func (o *AppEntitlementSearchServiceSearchRequest) GetResourceTraitIds() []string

func (*AppEntitlementSearchServiceSearchRequest) GetResourceTypeIds ¶ added in v1.7.0 

func (o *AppEntitlementSearchServiceSearchRequest) GetResourceTypeIds() []string

func (*AppEntitlementSearchServiceSearchRequest) GetRiskLevelIds ¶ added in v1.7.0 

func (o *AppEntitlementSearchServiceSearchRequest) GetRiskLevelIds() []string

type AppEntitlementSearchServiceSearchResponse ¶ added in v1.7.0 

type AppEntitlementSearchServiceSearchResponse struct {
	// Indicates one value of a facet.
	Facets *Facets `json:"facets,omitempty"`
	// List of related objects.
	Expanded []Expanded `json:"expanded,omitempty"`
	// List of app entitlement view objects.
	List []AppEntitlementView `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The AppEntitlementSearchServiceSearchResponse message.

func (*AppEntitlementSearchServiceSearchResponse) GetExpanded ¶ added in v1.7.0 

func (o *AppEntitlementSearchServiceSearchResponse) GetExpanded() []Expanded

func (*AppEntitlementSearchServiceSearchResponse) GetFacets ¶ added in v1.7.0 

func (o *AppEntitlementSearchServiceSearchResponse) GetFacets() *Facets

func (*AppEntitlementSearchServiceSearchResponse) GetList ¶ added in v1.7.0 

func (o *AppEntitlementSearchServiceSearchResponse) GetList() []AppEntitlementView

func (*AppEntitlementSearchServiceSearchResponse) GetNextPageToken ¶ added in v1.7.0 

func (o *AppEntitlementSearchServiceSearchResponse) GetNextPageToken() *string

type AppEntitlementUserBinding ¶ added in v1.0.3 

type AppEntitlementUserBinding struct {
	// The ID of the app entitlement that the app user has access to
	AppEntitlementID *string `json:"appEntitlementId,omitempty"`
	// The ID of the app associated with the app entitlement
	AppID *string `json:"appId,omitempty"`
	// The ID of the app user that has access to the app entitlement
	AppUserID     *string    `json:"appUserId,omitempty"`
	CreatedAt     *time.Time `json:"createdAt,omitempty"`
	DeletedAt     *time.Time `json:"deletedAt,omitempty"`
	DeprovisionAt *time.Time `json:"deprovisionAt,omitempty"`
}

The AppEntitlementUserBinding represents the relationship that gives an app user access to an app entitlement

func (*AppEntitlementUserBinding) GetAppEntitlementID ¶ added in v1.6.1 

func (o *AppEntitlementUserBinding) GetAppEntitlementID() *string

func (*AppEntitlementUserBinding) GetAppID ¶ added in v1.6.1 

func (o *AppEntitlementUserBinding) GetAppID() *string

func (*AppEntitlementUserBinding) GetAppUserID ¶ added in v1.6.1 

func (o *AppEntitlementUserBinding) GetAppUserID() *string

func (*AppEntitlementUserBinding) GetCreatedAt ¶ added in v1.6.1 

func (o *AppEntitlementUserBinding) GetCreatedAt() *time.Time

func (*AppEntitlementUserBinding) GetDeletedAt ¶ added in v1.6.1 

func (o *AppEntitlementUserBinding) GetDeletedAt() *time.Time

func (*AppEntitlementUserBinding) GetDeprovisionAt ¶ added in v1.6.1 

func (o *AppEntitlementUserBinding) GetDeprovisionAt() *time.Time

func (AppEntitlementUserBinding) MarshalJSON ¶ added in v1.10.1 

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

func (*AppEntitlementUserBinding) UnmarshalJSON ¶ added in v1.10.1 

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

type AppEntitlementUserBindingFeed ¶ added in v1.20.0 

type AppEntitlementUserBindingFeed struct {
	// The ID of the app entitlement that the app user has access to
	AppEntitlementID *string `json:"appEntitlementId,omitempty"`
	// The ID of the app associated with the app entitlement
	AppID *string `json:"appId,omitempty"`
	// The ID of the app user that has access to the app entitlement
	AppUserID *string    `json:"appUserId,omitempty"`
	Date      *time.Time `json:"date,omitempty"`
	// The eventType field.
	EventType *EventType `json:"eventType,omitempty"`
	// The ticketId field.
	TicketID *string `json:"ticketId,omitempty"`
}

The AppEntitlementUserBindingFeed message.

func (*AppEntitlementUserBindingFeed) GetAppEntitlementID ¶ added in v1.20.0 

func (o *AppEntitlementUserBindingFeed) GetAppEntitlementID() *string

func (*AppEntitlementUserBindingFeed) GetAppID ¶ added in v1.20.0 

func (o *AppEntitlementUserBindingFeed) GetAppID() *string

func (*AppEntitlementUserBindingFeed) GetAppUserID ¶ added in v1.20.0 

func (o *AppEntitlementUserBindingFeed) GetAppUserID() *string

func (*AppEntitlementUserBindingFeed) GetDate ¶ added in v1.20.0 

func (o *AppEntitlementUserBindingFeed) GetDate() *time.Time

func (*AppEntitlementUserBindingFeed) GetEventType ¶ added in v1.20.0 

func (o *AppEntitlementUserBindingFeed) GetEventType() *EventType

func (*AppEntitlementUserBindingFeed) GetTicketID ¶ added in v1.20.0 

func (o *AppEntitlementUserBindingFeed) GetTicketID() *string

func (AppEntitlementUserBindingFeed) MarshalJSON ¶ added in v1.20.0 

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

func (*AppEntitlementUserBindingFeed) UnmarshalJSON ¶ added in v1.20.0 

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

type AppEntitlementUserBindingFeedView ¶ added in v1.20.0 

type AppEntitlementUserBindingFeedView struct {
	// The AppEntitlementUserBindingFeed message.
	AppEntitlementUserBindingFeed *AppEntitlementUserBindingFeed `json:"feed,omitempty"`
	// The appPath field.
	AppPath *string `json:"appPath,omitempty"`
	// The appUserPath field.
	AppUserPath *string `json:"appUserPath,omitempty"`
	// The entitlementPath field.
	EntitlementPath *string `json:"entitlementPath,omitempty"`
	// The ticketPath field.
	TicketPath *string `json:"ticketPath,omitempty"`
}

The AppEntitlementUserBindingFeedView message.

func (*AppEntitlementUserBindingFeedView) GetAppEntitlementUserBindingFeed ¶ added in v1.20.0 

func (o *AppEntitlementUserBindingFeedView) GetAppEntitlementUserBindingFeed() *AppEntitlementUserBindingFeed

func (*AppEntitlementUserBindingFeedView) GetAppPath ¶ added in v1.20.0 

func (o *AppEntitlementUserBindingFeedView) GetAppPath() *string

func (*AppEntitlementUserBindingFeedView) GetAppUserPath ¶ added in v1.20.0 

func (o *AppEntitlementUserBindingFeedView) GetAppUserPath() *string

func (*AppEntitlementUserBindingFeedView) GetEntitlementPath ¶ added in v1.20.0 

func (o *AppEntitlementUserBindingFeedView) GetEntitlementPath() *string

func (*AppEntitlementUserBindingFeedView) GetTicketPath ¶ added in v1.20.0 

func (o *AppEntitlementUserBindingFeedView) GetTicketPath() *string

type AppEntitlementUserBindingHistory ¶ added in v1.19.0 

type AppEntitlementUserBindingHistory struct {
	// The ID of the app entitlement that the app user has access to
	AppEntitlementID *string `json:"appEntitlementId,omitempty"`
	// The ID of the app associated with the app entitlement
	AppID *string `json:"appId,omitempty"`
	// The ID of the app user that has access to the app entitlement
	AppUserID *string    `json:"appUserId,omitempty"`
	GrantedAt *time.Time `json:"grantedAt,omitempty"`
	RevokedAt *time.Time `json:"revokedAt,omitempty"`
}

The AppEntitlementUserBindingHistory message.

func (*AppEntitlementUserBindingHistory) GetAppEntitlementID ¶ added in v1.19.0 

func (o *AppEntitlementUserBindingHistory) GetAppEntitlementID() *string

func (*AppEntitlementUserBindingHistory) GetAppID ¶ added in v1.19.0 

func (o *AppEntitlementUserBindingHistory) GetAppID() *string

func (*AppEntitlementUserBindingHistory) GetAppUserID ¶ added in v1.19.0 

func (o *AppEntitlementUserBindingHistory) GetAppUserID() *string

func (*AppEntitlementUserBindingHistory) GetGrantedAt ¶ added in v1.19.0 

func (o *AppEntitlementUserBindingHistory) GetGrantedAt() *time.Time

func (*AppEntitlementUserBindingHistory) GetRevokedAt ¶ added in v1.19.0 

func (o *AppEntitlementUserBindingHistory) GetRevokedAt() *time.Time

func (AppEntitlementUserBindingHistory) MarshalJSON ¶ added in v1.19.0 

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

func (*AppEntitlementUserBindingHistory) UnmarshalJSON ¶ added in v1.19.0 

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

type AppEntitlementUserBindingHistoryView ¶ added in v1.19.0 

type AppEntitlementUserBindingHistoryView struct {
	// The AppEntitlementUserBindingHistory message.
	AppEntitlementUserBindingHistory *AppEntitlementUserBindingHistory `json:"history,omitempty"`
	// The appPath field.
	AppPath *string `json:"appPath,omitempty"`
	// The appUserPath field.
	AppUserPath *string `json:"appUserPath,omitempty"`
	// The entitlementPath field.
	EntitlementPath *string `json:"entitlementPath,omitempty"`
}

The AppEntitlementUserBindingHistoryView message.

func (*AppEntitlementUserBindingHistoryView) GetAppEntitlementUserBindingHistory ¶ added in v1.19.0 

func (o *AppEntitlementUserBindingHistoryView) GetAppEntitlementUserBindingHistory() *AppEntitlementUserBindingHistory

func (*AppEntitlementUserBindingHistoryView) GetAppPath ¶ added in v1.19.0 

func (o *AppEntitlementUserBindingHistoryView) GetAppPath() *string

func (*AppEntitlementUserBindingHistoryView) GetAppUserPath ¶ added in v1.19.0 

func (o *AppEntitlementUserBindingHistoryView) GetAppUserPath() *string

func (*AppEntitlementUserBindingHistoryView) GetEntitlementPath ¶ added in v1.19.0 

func (o *AppEntitlementUserBindingHistoryView) GetEntitlementPath() *string

type AppEntitlementUserView ¶ added in v1.7.0 

type AppEntitlementUserView struct {
	// The AppUserView contains an app user as well as paths for apps, identity users, and last usage in expanded arrays.
	AppUserView                            *AppUserView `json:"appUser,omitempty"`
	AppEntitlementUserBindingCreatedAt     *time.Time   `json:"appEntitlementUserBindingCreatedAt,omitempty"`
	AppEntitlementUserBindingDeprovisionAt *time.Time   `json:"appEntitlementUserBindingDeprovisionAt,omitempty"`
}

The AppEntitlementUserView (aka grant view) describes the relationship between an app user and an entitlement. They have more recently been referred to as grants.

func (*AppEntitlementUserView) GetAppEntitlementUserBindingCreatedAt ¶ added in v1.7.0 

func (o *AppEntitlementUserView) GetAppEntitlementUserBindingCreatedAt() *time.Time

func (*AppEntitlementUserView) GetAppEntitlementUserBindingDeprovisionAt ¶ added in v1.7.0 

func (o *AppEntitlementUserView) GetAppEntitlementUserBindingDeprovisionAt() *time.Time

func (*AppEntitlementUserView) GetAppUserView ¶ added in v1.7.0 

func (o *AppEntitlementUserView) GetAppUserView() *AppUserView

func (AppEntitlementUserView) MarshalJSON ¶ added in v1.10.1 

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

func (*AppEntitlementUserView) UnmarshalJSON ¶ added in v1.10.1 

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

type AppEntitlementView ¶ added in v1.0.3 

type AppEntitlementView struct {
	// The app entitlement represents one permission in a downstream App (SAAS) that can be granted. For example, GitHub Read vs GitHub Write.
	//
	// This message contains a oneof named max_grant_duration. Only a single field of the following list may be set at a time:
	//   - durationUnset
	//   - durationGrant
	//
	AppEntitlement *AppEntitlement `json:"appEntitlement,omitempty"`
	// JSONPATH expression indicating the location of the App object in the  array.
	AppPath *string `json:"appPath,omitempty"`
	// JSONPATH expression indicating the location of the App Resource Type object in the expanded array.
	AppResourcePath *string `json:"appResourcePath,omitempty"`
	// JSONPATH expression indicating the location of the App Resource object in the  array.
	AppResourceTypePath *string `json:"appResourceTypePath,omitempty"`
}

AppEntitlementView - The app entitlement view contains the serialized app entitlement and paths to objects referenced by the app entitlement.

func (*AppEntitlementView) GetAppEntitlement ¶ added in v1.6.1 

func (o *AppEntitlementView) GetAppEntitlement() *AppEntitlement

func (*AppEntitlementView) GetAppPath ¶ added in v1.6.1 

func (o *AppEntitlementView) GetAppPath() *string

func (*AppEntitlementView) GetAppResourcePath ¶ added in v1.6.1 

func (o *AppEntitlementView) GetAppResourcePath() *string

func (*AppEntitlementView) GetAppResourceTypePath ¶ added in v1.6.1 

func (o *AppEntitlementView) GetAppResourceTypePath() *string

type AppEntitlementWithExpired ¶ added in v1.18.3 

type AppEntitlementWithExpired struct {
	// Application User that represents an account in the application.
	AppUser *AppUser `json:"appUser,omitempty"`
	// The User object provides all of the details for an user, as well as some configuration.
	User *User `json:"user,omitempty"`
	// The appEntitlementId field.
	AppEntitlementID *string `json:"appEntitlementId,omitempty"`
	// The appId field.
	AppID *string `json:"appId,omitempty"`
	// The appUserId field.
	AppUserID  *string    `json:"appUserId,omitempty"`
	Discovered *time.Time `json:"discovered,omitempty"`
	Expired    *time.Time `json:"expired,omitempty"`
	// The grantReasons field.
	GrantReasons []GrantReason `json:"grantReasons,omitempty"`
}

The AppEntitlementWithExpired message.

func (*AppEntitlementWithExpired) GetAppEntitlementID ¶ added in v1.20.0 

func (o *AppEntitlementWithExpired) GetAppEntitlementID() *string

func (*AppEntitlementWithExpired) GetAppID ¶ added in v1.20.0 

func (o *AppEntitlementWithExpired) GetAppID() *string

func (*AppEntitlementWithExpired) GetAppUser ¶ added in v1.18.3 

func (o *AppEntitlementWithExpired) GetAppUser() *AppUser

func (*AppEntitlementWithExpired) GetAppUserID ¶ added in v1.20.0 

func (o *AppEntitlementWithExpired) GetAppUserID() *string

func (*AppEntitlementWithExpired) GetDiscovered ¶ added in v1.18.3 

func (o *AppEntitlementWithExpired) GetDiscovered() *time.Time

func (*AppEntitlementWithExpired) GetExpired ¶ added in v1.18.3 

func (o *AppEntitlementWithExpired) GetExpired() *time.Time

func (*AppEntitlementWithExpired) GetGrantReasons ¶ added in v1.20.0 

func (o *AppEntitlementWithExpired) GetGrantReasons() []GrantReason

func (*AppEntitlementWithExpired) GetUser ¶ added in v1.18.3 

func (o *AppEntitlementWithExpired) GetUser() *User

func (AppEntitlementWithExpired) MarshalJSON ¶ added in v1.18.3 

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

func (*AppEntitlementWithExpired) UnmarshalJSON ¶ added in v1.18.3 

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

type AppEntitlementWithUserBindings ¶ added in v1.0.3 

type AppEntitlementWithUserBindings struct {
	// The app entitlement view contains the serialized app entitlement and paths to objects referenced by the app entitlement.
	AppEntitlementView *AppEntitlementView `json:"entitlement,omitempty"`
	// An array of AppEntitlementUserBinding objects which represent the relationships that give app users access to the specific app entitlement.
	AppEntitlementUserBindings []AppEntitlementUserBinding `json:"appEntitlementUserBindings,omitempty"`
}

The AppEntitlementWithUserBindings message represents an app entitlement and its associated user bindings.

func (*AppEntitlementWithUserBindings) GetAppEntitlementUserBindings ¶ added in v1.6.1 

func (o *AppEntitlementWithUserBindings) GetAppEntitlementUserBindings() []AppEntitlementUserBinding

func (*AppEntitlementWithUserBindings) GetAppEntitlementView ¶ added in v1.6.1 

func (o *AppEntitlementWithUserBindings) GetAppEntitlementView() *AppEntitlementView

type AppGroupApproval ¶ added in v1.0.3 

type AppGroupApproval struct {
	// Configuration to allow self approval if the target user is a member of the group during this step.
	AllowSelfApproval *bool `json:"allowSelfApproval,omitempty"`
	// The ID of the group specified for approval.
	AppGroupID *string `json:"appGroupId,omitempty"`
	// The ID of the app that contains the group specified for approval.
	AppID *string `json:"appId,omitempty"`
	// Configuration to allow a fallback if the group is empty.
	Fallback *bool `json:"fallback,omitempty"`
	// Configuration to specific which users to fallback to if fallback is enabled and the group is empty.
	FallbackUserIds []string `json:"fallbackUserIds,omitempty"`
}

The AppGroupApproval object provides the configuration for setting a group as the approvers of an approval policy step.

func (*AppGroupApproval) GetAllowSelfApproval ¶ added in v1.6.1 

func (o *AppGroupApproval) GetAllowSelfApproval() *bool

func (*AppGroupApproval) GetAppGroupID ¶ added in v1.6.1 

func (o *AppGroupApproval) GetAppGroupID() *string

func (*AppGroupApproval) GetAppID ¶ added in v1.6.1 

func (o *AppGroupApproval) GetAppID() *string

func (*AppGroupApproval) GetFallback ¶ added in v1.6.1 

func (o *AppGroupApproval) GetFallback() *bool

func (*AppGroupApproval) GetFallbackUserIds ¶ added in v1.6.1 

func (o *AppGroupApproval) GetFallbackUserIds() []string

type AppInput ¶ added in v1.7.0 

type AppInput struct {
	// The ID of the Certify Policy associated with this App.
	CertifyPolicyID *string `json:"certifyPolicyId,omitempty"`
	// The app's description.
	Description *string `json:"description,omitempty"`
	// The app's display name.
	DisplayName *string `json:"displayName,omitempty"`
	// The ID of the Grant Policy associated with this App.
	GrantPolicyID *string `json:"grantPolicyId,omitempty"`
	// The URL of an icon to display for the app.
	IconURL *string `json:"iconUrl,omitempty"`
	// The identityMatching field.
	IdentityMatching *IdentityMatching `json:"identityMatching,omitempty"`
	// The isManuallyManaged field.
	IsManuallyManaged *bool `json:"isManuallyManaged,omitempty"`
	// The cost of an app per-seat, so that total cost can be calculated by the grant count.
	MonthlyCostUsd *int `json:"monthlyCostUsd,omitempty"`
	// The ID of the Revoke Policy associated with this App.
	RevokePolicyID *string `json:"revokePolicyId,omitempty"`
}

AppInput - The App object provides all of the details for an app, as well as some configuration.

func (*AppInput) GetCertifyPolicyID ¶ added in v1.7.0 

func (o *AppInput) GetCertifyPolicyID() *string

func (*AppInput) GetDescription ¶ added in v1.7.0 

func (o *AppInput) GetDescription() *string

func (*AppInput) GetDisplayName ¶ added in v1.7.0 

func (o *AppInput) GetDisplayName() *string

func (*AppInput) GetGrantPolicyID ¶ added in v1.7.0 

func (o *AppInput) GetGrantPolicyID() *string

func (*AppInput) GetIconURL ¶ added in v1.7.0 

func (o *AppInput) GetIconURL() *string

func (*AppInput) GetIdentityMatching ¶ added in v1.18.3 

func (o *AppInput) GetIdentityMatching() *IdentityMatching

func (*AppInput) GetIsManuallyManaged ¶ added in v1.21.3 

func (o *AppInput) GetIsManuallyManaged() *bool

func (*AppInput) GetMonthlyCostUsd ¶ added in v1.7.0 

func (o *AppInput) GetMonthlyCostUsd() *int

func (*AppInput) GetRevokePolicyID ¶ added in v1.7.0 

func (o *AppInput) GetRevokePolicyID() *string

type AppManagedStateBindingRef ¶ added in v1.20.0 

type AppManagedStateBindingRef struct {
	// The appId field.
	AppID *string `json:"appId,omitempty"`
	// The resourceId field.
	ResourceID *string `json:"resourceId,omitempty"`
	// The resourceTypeId field.
	ResourceTypeID *string `json:"resourceTypeId,omitempty"`
}

The AppManagedStateBindingRef message.

func (*AppManagedStateBindingRef) GetAppID ¶ added in v1.20.0 

func (o *AppManagedStateBindingRef) GetAppID() *string

func (*AppManagedStateBindingRef) GetResourceID ¶ added in v1.20.0 

func (o *AppManagedStateBindingRef) GetResourceID() *string

func (*AppManagedStateBindingRef) GetResourceTypeID ¶ added in v1.20.0 

func (o *AppManagedStateBindingRef) GetResourceTypeID() *string

type AppOwnerApproval ¶ added in v1.0.3 

type AppOwnerApproval struct {
	// Configuration that allows a user to self approve if they are an app owner during this approval step.
	AllowSelfApproval *bool `json:"allowSelfApproval,omitempty"`
}

AppOwnerApproval - App owner approval provides the configuration for an approval step when the app owner is the target.

func (*AppOwnerApproval) GetAllowSelfApproval ¶ added in v1.6.1 

func (o *AppOwnerApproval) GetAllowSelfApproval() *bool

type AppPopulationReport ¶ added in v1.0.3 

type AppPopulationReport struct {
	// The appId is the Id of the app which the report is generated for.
	AppID     *string    `json:"appId,omitempty"`
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// The downloadUrl is the url used for downloading the AppPopulationReport.
	DownloadURL *string `json:"downloadUrl,omitempty"`
	// The hashes field contains the file hashes of the report.
	Hashes map[string]string `json:"hashes,omitempty"`
	// The id field.
	ID *string `json:"id,omitempty"`
	// The state field tracks the state of the AppPopulationReport. This state field can be one of REPORT_STATE_PENDING, REPORT_STATE_UNSPECIFIED, REPORT_STATE_OK, REPORT_STATE_ERROR.
	State *AppPopulationReportState `json:"state,omitempty"`
}

The AppPopulationReport is a generated report for a specific app that gives details about the app's users. These details include what groups, roles, and other entitlements the users have access to.

func (*AppPopulationReport) GetAppID ¶ added in v1.6.1 

func (o *AppPopulationReport) GetAppID() *string

func (*AppPopulationReport) GetCreatedAt ¶ added in v1.6.1 

func (o *AppPopulationReport) GetCreatedAt() *time.Time

func (*AppPopulationReport) GetDownloadURL ¶ added in v1.6.1 

func (o *AppPopulationReport) GetDownloadURL() *string

func (*AppPopulationReport) GetHashes ¶ added in v1.6.1 

func (o *AppPopulationReport) GetHashes() map[string]string

func (*AppPopulationReport) GetID ¶ added in v1.6.1 

func (o *AppPopulationReport) GetID() *string

func (*AppPopulationReport) GetState ¶ added in v1.6.1 

func (o *AppPopulationReport) GetState() *AppPopulationReportState

func (AppPopulationReport) MarshalJSON ¶ added in v1.10.1 

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

func (*AppPopulationReport) UnmarshalJSON ¶ added in v1.10.1 

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

type AppPopulationReportState ¶ added in v1.0.3 

type AppPopulationReportState string

AppPopulationReportState - The state field tracks the state of the AppPopulationReport. This state field can be one of REPORT_STATE_PENDING, REPORT_STATE_UNSPECIFIED, REPORT_STATE_OK, REPORT_STATE_ERROR. 

const (
	AppPopulationReportStateReportStateUnspecified AppPopulationReportState = "REPORT_STATE_UNSPECIFIED"
	AppPopulationReportStateReportStatePending     AppPopulationReportState = "REPORT_STATE_PENDING"
	AppPopulationReportStateReportStateOk          AppPopulationReportState = "REPORT_STATE_OK"
	AppPopulationReportStateReportStateError       AppPopulationReportState = "REPORT_STATE_ERROR"
)

func (AppPopulationReportState) ToPointer ¶ added in v1.0.3 

func (e AppPopulationReportState) ToPointer() *AppPopulationReportState

type AppReportServiceListResponse ¶ added in v1.0.3 

type AppReportServiceListResponse struct {
	// The list of results containing up to X results, where X is the page size defined in the request.
	List []AppPopulationReport `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retreived.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The AppReportServiceListResponse message contains a list of results and a nextPageToken if applicable.

func (*AppReportServiceListResponse) GetList ¶ added in v1.6.1 

func (o *AppReportServiceListResponse) GetList() []AppPopulationReport

func (*AppReportServiceListResponse) GetNextPageToken ¶ added in v1.6.1 

func (o *AppReportServiceListResponse) GetNextPageToken() *string

type AppResource ¶ added in v1.0.3 

type AppResource struct {
	// The app that this resource belongs to.
	AppID *string `json:"appId,omitempty"`
	// The resource type that this resource is.
	AppResourceTypeID *string    `json:"appResourceTypeId,omitempty"`
	CreatedAt         *time.Time `json:"createdAt,omitempty"`
	// A custom description that can be set for a resource.
	CustomDescription *string    `json:"customDescription,omitempty"`
	DeletedAt         *time.Time `json:"deletedAt,omitempty"`
	// The description set for the resource.
	Description *string `json:"description,omitempty"`
	// The display name for this resource.
	DisplayName *string `json:"displayName,omitempty"`
	// The number of grants to this resource.
	GrantCount *int64 `integer:"string" json:"grantCount,omitempty"`
	// The id of the resource.
	ID *string `json:"id,omitempty"`
	// The parent resource id, if this resource is a child of another resource.
	ParentAppResourceID *string `json:"parentAppResourceId,omitempty"`
	// The parent resource type id, if this resource is a child of another resource.
	ParentAppResourceTypeID *string    `json:"parentAppResourceTypeId,omitempty"`
	UpdatedAt               *time.Time `json:"updatedAt,omitempty"`
}

AppResource - The app resource message is a single resource that can have entitlements.

func (*AppResource) GetAppID ¶ added in v1.6.1 

func (o *AppResource) GetAppID() *string

func (*AppResource) GetAppResourceTypeID ¶ added in v1.6.1 

func (o *AppResource) GetAppResourceTypeID() *string

func (*AppResource) GetCreatedAt ¶ added in v1.6.1 

func (o *AppResource) GetCreatedAt() *time.Time

func (*AppResource) GetCustomDescription ¶ added in v1.6.1 

func (o *AppResource) GetCustomDescription() *string

func (*AppResource) GetDeletedAt ¶ added in v1.6.1 

func (o *AppResource) GetDeletedAt() *time.Time

func (*AppResource) GetDescription ¶ added in v1.6.1 

func (o *AppResource) GetDescription() *string

func (*AppResource) GetDisplayName ¶ added in v1.6.1 

func (o *AppResource) GetDisplayName() *string

func (*AppResource) GetGrantCount ¶ added in v1.6.1 

func (o *AppResource) GetGrantCount() *int64

func (*AppResource) GetID ¶ added in v1.6.1 

func (o *AppResource) GetID() *string

func (*AppResource) GetParentAppResourceID ¶ added in v1.15.0 

func (o *AppResource) GetParentAppResourceID() *string

func (*AppResource) GetParentAppResourceTypeID ¶ added in v1.15.0 

func (o *AppResource) GetParentAppResourceTypeID() *string

func (*AppResource) GetUpdatedAt ¶ added in v1.6.1 

func (o *AppResource) GetUpdatedAt() *time.Time

func (AppResource) MarshalJSON ¶ added in v1.10.1 

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

func (*AppResource) UnmarshalJSON ¶ added in v1.10.1 

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

type AppResourceExpandMask ¶ added in v1.20.0 

type AppResourceExpandMask struct {
	// The app resource expanded fields. Maybe be any combination of "*", "app_id", "app_resource_type_id".
	Paths []string `json:"paths,omitempty"`
}

AppResourceExpandMask - The app resource expand mask lets you get information about related objects from the request.

func (*AppResourceExpandMask) GetPaths ¶ added in v1.20.0 

func (o *AppResourceExpandMask) GetPaths() []string

type AppResourceInput ¶ added in v1.20.0 

type AppResourceInput struct {
	// The app that this resource belongs to.
	AppID *string `json:"appId,omitempty"`
	// The resource type that this resource is.
	AppResourceTypeID *string `json:"appResourceTypeId,omitempty"`
	// A custom description that can be set for a resource.
	CustomDescription *string `json:"customDescription,omitempty"`
	// The display name for this resource.
	DisplayName *string `json:"displayName,omitempty"`
	// The number of grants to this resource.
	GrantCount *int64 `integer:"string" json:"grantCount,omitempty"`
	// The id of the resource.
	ID *string `json:"id,omitempty"`
	// The parent resource id, if this resource is a child of another resource.
	ParentAppResourceID *string `json:"parentAppResourceId,omitempty"`
	// The parent resource type id, if this resource is a child of another resource.
	ParentAppResourceTypeID *string `json:"parentAppResourceTypeId,omitempty"`
}

AppResourceInput - The app resource message is a single resource that can have entitlements.

func (*AppResourceInput) GetAppID ¶ added in v1.20.0 

func (o *AppResourceInput) GetAppID() *string

func (*AppResourceInput) GetAppResourceTypeID ¶ added in v1.20.0 

func (o *AppResourceInput) GetAppResourceTypeID() *string

func (*AppResourceInput) GetCustomDescription ¶ added in v1.20.0 

func (o *AppResourceInput) GetCustomDescription() *string

func (*AppResourceInput) GetDisplayName ¶ added in v1.20.0 

func (o *AppResourceInput) GetDisplayName() *string

func (*AppResourceInput) GetGrantCount ¶ added in v1.20.0 

func (o *AppResourceInput) GetGrantCount() *int64

func (*AppResourceInput) GetID ¶ added in v1.20.0 

func (o *AppResourceInput) GetID() *string

func (*AppResourceInput) GetParentAppResourceID ¶ added in v1.20.0 

func (o *AppResourceInput) GetParentAppResourceID() *string

func (*AppResourceInput) GetParentAppResourceTypeID ¶ added in v1.20.0 

func (o *AppResourceInput) GetParentAppResourceTypeID() *string

type AppResourceServiceGetResponse ¶ added in v1.0.3 

type AppResourceServiceGetResponse struct {
	// The app resource view returns an app resource with paths for items in the expand mask filled in when this response is returned and a request expand mask has "*" or "app_id" or "resource_type_id".
	AppResourceView *AppResourceView `json:"appResourceView,omitempty"`
	// List of serialized related objects.
	Expanded []AppResourceServiceGetResponseExpanded `json:"expanded,omitempty"`
}

AppResourceServiceGetResponse - The app resource service get response contains the app resource view and array of expanded items indicated by the request's expand mask.

func (*AppResourceServiceGetResponse) GetAppResourceView ¶ added in v1.6.1 

func (o *AppResourceServiceGetResponse) GetAppResourceView() *AppResourceView

func (*AppResourceServiceGetResponse) GetExpanded ¶ added in v1.6.1 

func (o *AppResourceServiceGetResponse) GetExpanded() []AppResourceServiceGetResponseExpanded

type AppResourceServiceGetResponseExpanded ¶ added in v1.10.1 

type AppResourceServiceGetResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

AppResourceServiceGetResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*AppResourceServiceGetResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *AppResourceServiceGetResponseExpanded) GetAdditionalProperties() map[string]any

func (*AppResourceServiceGetResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *AppResourceServiceGetResponseExpanded) GetAtType() *string

func (AppResourceServiceGetResponseExpanded) MarshalJSON ¶ added in v1.10.1 

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

func (*AppResourceServiceGetResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

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

type AppResourceServiceListResponse ¶ added in v1.0.3 

type AppResourceServiceListResponse struct {
	// List of serialized related objects.
	Expanded []AppResourceServiceListResponseExpanded `json:"expanded,omitempty"`
	// The list of results containing up to X results, where X is the page size defined in the request.
	List []AppResourceView `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retreived.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The AppResourceServiceListResponse message contains a list of results and a nextPageToken if applicable.

func (*AppResourceServiceListResponse) GetExpanded ¶ added in v1.6.1 

func (o *AppResourceServiceListResponse) GetExpanded() []AppResourceServiceListResponseExpanded

func (*AppResourceServiceListResponse) GetList ¶ added in v1.6.1 

func (o *AppResourceServiceListResponse) GetList() []AppResourceView

func (*AppResourceServiceListResponse) GetNextPageToken ¶ added in v1.6.1 

func (o *AppResourceServiceListResponse) GetNextPageToken() *string

type AppResourceServiceListResponseExpanded ¶ added in v1.10.1 

type AppResourceServiceListResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

AppResourceServiceListResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*AppResourceServiceListResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *AppResourceServiceListResponseExpanded) GetAdditionalProperties() map[string]any

func (*AppResourceServiceListResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *AppResourceServiceListResponseExpanded) GetAtType() *string

func (AppResourceServiceListResponseExpanded) MarshalJSON ¶ added in v1.10.1 

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

func (*AppResourceServiceListResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

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

type AppResourceServiceUpdateRequest ¶ added in v1.20.0 

type AppResourceServiceUpdateRequest struct {
	// The app resource message is a single resource that can have entitlements.
	AppResource *AppResourceInput `json:"appResource,omitempty"`
	// The app resource expand mask lets you get information about related objects from the request.
	AppResourceExpandMask *AppResourceExpandMask `json:"expandMask,omitempty"`
	UpdateMask            *string                `json:"updateMask,omitempty"`
}

The AppResourceServiceUpdateRequest message.

func (*AppResourceServiceUpdateRequest) GetAppResource ¶ added in v1.20.0 

func (o *AppResourceServiceUpdateRequest) GetAppResource() *AppResourceInput

func (*AppResourceServiceUpdateRequest) GetAppResourceExpandMask ¶ added in v1.20.0 

func (o *AppResourceServiceUpdateRequest) GetAppResourceExpandMask() *AppResourceExpandMask

func (*AppResourceServiceUpdateRequest) GetUpdateMask ¶ added in v1.20.0 

func (o *AppResourceServiceUpdateRequest) GetUpdateMask() *string

type AppResourceServiceUpdateResponse ¶ added in v1.20.0 

type AppResourceServiceUpdateResponse struct {
	// The app resource view returns an app resource with paths for items in the expand mask filled in when this response is returned and a request expand mask has "*" or "app_id" or "resource_type_id".
	AppResourceView *AppResourceView `json:"appResourceView,omitempty"`
	// The expanded field.
	Expanded []AppResourceServiceUpdateResponseExpanded `json:"expanded,omitempty"`
}

The AppResourceServiceUpdateResponse message.

func (*AppResourceServiceUpdateResponse) GetAppResourceView ¶ added in v1.20.0 

func (o *AppResourceServiceUpdateResponse) GetAppResourceView() *AppResourceView

func (*AppResourceServiceUpdateResponse) GetExpanded ¶ added in v1.20.0 

func (o *AppResourceServiceUpdateResponse) GetExpanded() []AppResourceServiceUpdateResponseExpanded

type AppResourceServiceUpdateResponseExpanded ¶ added in v1.20.0 

type AppResourceServiceUpdateResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

AppResourceServiceUpdateResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*AppResourceServiceUpdateResponseExpanded) GetAdditionalProperties ¶ added in v1.20.0 

func (o *AppResourceServiceUpdateResponseExpanded) GetAdditionalProperties() map[string]any

func (*AppResourceServiceUpdateResponseExpanded) GetAtType ¶ added in v1.20.0 

func (o *AppResourceServiceUpdateResponseExpanded) GetAtType() *string

func (AppResourceServiceUpdateResponseExpanded) MarshalJSON ¶ added in v1.20.0 

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

func (*AppResourceServiceUpdateResponseExpanded) UnmarshalJSON ¶ added in v1.20.0 

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

type AppResourceType ¶ added in v1.0.3 

type AppResourceType struct {
	// The ID of the app that is associated with the app resource type
	AppID     *string    `json:"appId,omitempty"`
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
	// The display name of the app resource type.
	DisplayName *string `json:"displayName,omitempty"`
	// The unique ID for the app resource type.
	ID        *string    `json:"id,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}

The AppResourceType is referenced by an app entitlement defining its resource types. Commonly things like Group or Role.

func (*AppResourceType) GetAppID ¶ added in v1.6.1 

func (o *AppResourceType) GetAppID() *string

func (*AppResourceType) GetCreatedAt ¶ added in v1.6.1 

func (o *AppResourceType) GetCreatedAt() *time.Time

func (*AppResourceType) GetDeletedAt ¶ added in v1.6.1 

func (o *AppResourceType) GetDeletedAt() *time.Time

func (*AppResourceType) GetDisplayName ¶ added in v1.6.1 

func (o *AppResourceType) GetDisplayName() *string

func (*AppResourceType) GetID ¶ added in v1.6.1 

func (o *AppResourceType) GetID() *string

func (*AppResourceType) GetUpdatedAt ¶ added in v1.6.1 

func (o *AppResourceType) GetUpdatedAt() *time.Time

func (AppResourceType) MarshalJSON ¶ added in v1.10.1 

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

func (*AppResourceType) UnmarshalJSON ¶ added in v1.10.1 

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

type AppResourceTypeInput ¶ added in v1.20.0 

type AppResourceTypeInput struct {
	// The display name of the app resource type.
	DisplayName *string `json:"displayName,omitempty"`
}

AppResourceTypeInput - The AppResourceType is referenced by an app entitlement defining its resource types. Commonly things like Group or Role.

func (*AppResourceTypeInput) GetDisplayName ¶ added in v1.20.0 

func (o *AppResourceTypeInput) GetDisplayName() *string

type AppResourceTypeServiceGetResponse ¶ added in v1.0.3 

type AppResourceTypeServiceGetResponse struct {
	// The AppResourceTypeView message.
	AppResourceTypeView *AppResourceTypeView `json:"appResourceTypeView,omitempty"`
	// List of serialized related objects.
	Expanded []AppResourceTypeServiceGetResponseExpanded `json:"expanded,omitempty"`
}

The AppResourceTypeServiceGetResponse contains an expanded array containing the expanded values indicated by the expand mask 

in the request and an app resource type view containing the resource type and JSONPATHs indicating which objects are where in the expand mask.

func (*AppResourceTypeServiceGetResponse) GetAppResourceTypeView ¶ added in v1.6.1 

func (o *AppResourceTypeServiceGetResponse) GetAppResourceTypeView() *AppResourceTypeView

func (*AppResourceTypeServiceGetResponse) GetExpanded ¶ added in v1.6.1 

func (o *AppResourceTypeServiceGetResponse) GetExpanded() []AppResourceTypeServiceGetResponseExpanded

type AppResourceTypeServiceGetResponseExpanded ¶ added in v1.10.1 

type AppResourceTypeServiceGetResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

AppResourceTypeServiceGetResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*AppResourceTypeServiceGetResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *AppResourceTypeServiceGetResponseExpanded) GetAdditionalProperties() map[string]any

func (*AppResourceTypeServiceGetResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *AppResourceTypeServiceGetResponseExpanded) GetAtType() *string

func (AppResourceTypeServiceGetResponseExpanded) MarshalJSON ¶ added in v1.10.1 

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

func (*AppResourceTypeServiceGetResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

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

type AppResourceTypeServiceListResponse ¶ added in v1.1.1 

type AppResourceTypeServiceListResponse struct {
	// List of serialized related objects.
	Expanded []AppResourceTypeServiceListResponseExpanded `json:"expanded,omitempty"`
	// The list of results containing up to X results, where X is the page size defined in the request.
	List []AppResourceTypeView `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retreived.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The AppResourceTypeServiceListResponse message contains a list of results and a nextPageToken if applicable.

func (*AppResourceTypeServiceListResponse) GetExpanded ¶ added in v1.6.1 

func (o *AppResourceTypeServiceListResponse) GetExpanded() []AppResourceTypeServiceListResponseExpanded

func (*AppResourceTypeServiceListResponse) GetList ¶ added in v1.6.1 

func (o *AppResourceTypeServiceListResponse) GetList() []AppResourceTypeView

func (*AppResourceTypeServiceListResponse) GetNextPageToken ¶ added in v1.6.1 

func (o *AppResourceTypeServiceListResponse) GetNextPageToken() *string

type AppResourceTypeServiceListResponseExpanded ¶ added in v1.10.1 

type AppResourceTypeServiceListResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

AppResourceTypeServiceListResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*AppResourceTypeServiceListResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *AppResourceTypeServiceListResponseExpanded) GetAdditionalProperties() map[string]any

func (*AppResourceTypeServiceListResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *AppResourceTypeServiceListResponseExpanded) GetAtType() *string

func (AppResourceTypeServiceListResponseExpanded) MarshalJSON ¶ added in v1.10.1 

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

func (*AppResourceTypeServiceListResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

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

type AppResourceTypeView ¶ added in v1.0.3 

type AppResourceTypeView struct {
	// The AppResourceType is referenced by an app entitlement defining its resource types. Commonly things like Group or Role.
	AppResourceType *AppResourceType `json:"appResourceType,omitempty"`
	// JSONPATH expression indicating the location of the App object in the  array
	AppPath *string `json:"appPath,omitempty"`
}

The AppResourceTypeView message.

func (*AppResourceTypeView) GetAppPath ¶ added in v1.6.1 

func (o *AppResourceTypeView) GetAppPath() *string

func (*AppResourceTypeView) GetAppResourceType ¶ added in v1.6.1 

func (o *AppResourceTypeView) GetAppResourceType() *AppResourceType

type AppResourceView ¶ added in v1.0.3 

type AppResourceView struct {
	// The app resource message is a single resource that can have entitlements.
	AppResource *AppResource `json:"appResource,omitempty"`
	// JSONPATH expression indicating the location of the App object in the array
	AppPath *string `json:"appPath,omitempty"`
	// JSONPATH expression indicating the location of the Parent Resource object in the array
	ParentResourcePath *string `json:"parentResourcePath,omitempty"`
	// JSONPATH expression indicating the location of the Parent Resource Type object in the array
	ParentResourceTypePath *string `json:"parentResourceTypePath,omitempty"`
	// JSONPATH expression indicating the location of the Resource Type object in the array
	ResourceTypePath *string `json:"resourceTypePath,omitempty"`
}

AppResourceView - The app resource view returns an app resource with paths for items in the expand mask filled in when this response is returned and a request expand mask has "*" or "app_id" or "resource_type_id".

func (*AppResourceView) GetAppPath ¶ added in v1.6.1 

func (o *AppResourceView) GetAppPath() *string

func (*AppResourceView) GetAppResource ¶ added in v1.6.1 

func (o *AppResourceView) GetAppResource() *AppResource

func (*AppResourceView) GetParentResourcePath ¶ added in v1.15.0 

func (o *AppResourceView) GetParentResourcePath() *string

func (*AppResourceView) GetParentResourceTypePath ¶ added in v1.15.0 

func (o *AppResourceView) GetParentResourceTypePath() *string

func (*AppResourceView) GetResourceTypePath ¶ added in v1.6.1 

func (o *AppResourceView) GetResourceTypePath() *string

type AppUsageControls ¶ added in v1.0.3 

type AppUsageControls struct {
	// The app that this object belongs to.
	AppID *string `json:"appId,omitempty"`
	// Whether or not to notify some if they have access to the app, but has not used it within a configurable amount of time.
	Notify *bool `json:"notify,omitempty"`
	// The duration in days after which we notify users of nonusage.
	NotifyAfterDays *int64 `json:"notifyAfterDays,omitempty"`
	// Whether or not to revoke a grant if they have access to the app, but has not used it within a configurable amount of time.
	Revoke *bool `json:"revoke,omitempty"`
	// The duration in days after which we revoke users that have not used that grant.
	RevokeAfterDays *int64 `json:"revokeAfterDays,omitempty"`
}

The AppUsageControls object describes some peripheral configuration for an app.

func (*AppUsageControls) GetAppID ¶ added in v1.6.1 

func (o *AppUsageControls) GetAppID() *string

func (*AppUsageControls) GetNotify ¶ added in v1.6.1 

func (o *AppUsageControls) GetNotify() *bool

func (*AppUsageControls) GetNotifyAfterDays ¶ added in v1.6.1 

func (o *AppUsageControls) GetNotifyAfterDays() *int64

func (*AppUsageControls) GetRevoke ¶ added in v1.6.1 

func (o *AppUsageControls) GetRevoke() *bool

func (*AppUsageControls) GetRevokeAfterDays ¶ added in v1.6.1 

func (o *AppUsageControls) GetRevokeAfterDays() *int64

type AppUser ¶ added in v1.7.0 

type AppUser struct {
	// The satus of the applicaiton user.
	AppUserStatus *AppUserStatus `json:"status,omitempty"`
	// The ID of the application.
	AppID *string `json:"appId,omitempty"`
	// The appplication user type. Type can be user, system or service.
	AppUserType *AppUserType `json:"appUserType,omitempty"`
	CreatedAt   *time.Time   `json:"createdAt,omitempty"`
	DeletedAt   *time.Time   `json:"deletedAt,omitempty"`
	// The display name of the application user.
	DisplayName *string `json:"displayName,omitempty"`
	// The email field of the application user.
	Email *string `json:"email,omitempty"`
	// The emails field of the application user.
	Emails []string `json:"emails,omitempty"`
	// A unique idenditfier of the application user.
	ID *string `json:"id,omitempty"`
	// The conductor one user ID of the account owner.
	IdentityUserID *string        `json:"identityUserId,omitempty"`
	Profile        map[string]any `json:"profile,omitempty"`
	UpdatedAt      *time.Time     `json:"updatedAt,omitempty"`
	// The username field of the application user.
	Username *string `json:"username,omitempty"`
	// The usernames field of the application user.
	Usernames []string `json:"usernames,omitempty"`
}

AppUser - Application User that represents an account in the application.

func (*AppUser) GetAppID ¶ added in v1.7.0 

func (o *AppUser) GetAppID() *string

func (*AppUser) GetAppUserStatus ¶ added in v1.7.0 

func (o *AppUser) GetAppUserStatus() *AppUserStatus

func (*AppUser) GetAppUserType ¶ added in v1.7.0 

func (o *AppUser) GetAppUserType() *AppUserType

func (*AppUser) GetCreatedAt ¶ added in v1.7.0 

func (o *AppUser) GetCreatedAt() *time.Time

func (*AppUser) GetDeletedAt ¶ added in v1.7.0 

func (o *AppUser) GetDeletedAt() *time.Time

func (*AppUser) GetDisplayName ¶ added in v1.7.0 

func (o *AppUser) GetDisplayName() *string

func (*AppUser) GetEmail ¶ added in v1.7.0 

func (o *AppUser) GetEmail() *string

func (*AppUser) GetEmails ¶ added in v1.14.0 

func (o *AppUser) GetEmails() []string

func (*AppUser) GetID ¶ added in v1.7.0 

func (o *AppUser) GetID() *string

func (*AppUser) GetIdentityUserID ¶ added in v1.7.0 

func (o *AppUser) GetIdentityUserID() *string

func (*AppUser) GetProfile ¶ added in v1.7.0 

func (o *AppUser) GetProfile() map[string]any

func (*AppUser) GetUpdatedAt ¶ added in v1.7.0 

func (o *AppUser) GetUpdatedAt() *time.Time

func (*AppUser) GetUsername ¶ added in v1.14.0 

func (o *AppUser) GetUsername() *string

func (*AppUser) GetUsernames ¶ added in v1.14.0 

func (o *AppUser) GetUsernames() []string

func (AppUser) MarshalJSON ¶ added in v1.10.1 

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

func (*AppUser) UnmarshalJSON ¶ added in v1.10.1 

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

type AppUserCredential ¶ added in v1.21.4 

type AppUserCredential struct {
	// EncryptedData is a message that contains encrypted bytes and metadata.
	EncryptedData *EncryptedData `json:"encryptedData,omitempty"`
	// The ID of the application.
	AppID *string `json:"appId,omitempty"`
	// A unique identifier of the application user.
	AppUserID *string    `json:"appUserId,omitempty"`
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
	// A unique identifier of the credential.
	ID        *string    `json:"id,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}

AppUserCredential - A credentials for the Application User that represents an account in the application.

This message contains a oneof named credential. Only a single field of the following list may be set at a time:

  • encryptedData

func (*AppUserCredential) GetAppID ¶ added in v1.21.4 

func (o *AppUserCredential) GetAppID() *string

func (*AppUserCredential) GetAppUserID ¶ added in v1.21.4 

func (o *AppUserCredential) GetAppUserID() *string

func (*AppUserCredential) GetCreatedAt ¶ added in v1.21.4 

func (o *AppUserCredential) GetCreatedAt() *time.Time

func (*AppUserCredential) GetDeletedAt ¶ added in v1.21.4 

func (o *AppUserCredential) GetDeletedAt() *time.Time

func (*AppUserCredential) GetEncryptedData ¶ added in v1.21.4 

func (o *AppUserCredential) GetEncryptedData() *EncryptedData

func (*AppUserCredential) GetID ¶ added in v1.21.4 

func (o *AppUserCredential) GetID() *string

func (*AppUserCredential) GetUpdatedAt ¶ added in v1.21.4 

func (o *AppUserCredential) GetUpdatedAt() *time.Time

func (AppUserCredential) MarshalJSON ¶ added in v1.21.4 

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

func (*AppUserCredential) UnmarshalJSON ¶ added in v1.21.4 

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

type AppUserExpandMask ¶ added in v1.8.0 

type AppUserExpandMask struct {
	// The paths to expand in the response. May be any combination of "*", "identity_user_id", "app_id", and "last_usage".
	Paths []string `json:"paths,omitempty"`
}

The AppUserExpandMask message contains a list of paths to expand in the response.

func (*AppUserExpandMask) GetPaths ¶ added in v1.8.0 

func (o *AppUserExpandMask) GetPaths() []string

type AppUserInput ¶ added in v1.8.0 

type AppUserInput struct {
	// The satus of the applicaiton user.
	AppUserStatus *AppUserStatusInput `json:"status,omitempty"`
	// The appplication user type. Type can be user, system or service.
	AppUserType *AppUserType `json:"appUserType,omitempty"`
}

AppUserInput - Application User that represents an account in the application.

func (*AppUserInput) GetAppUserStatus ¶ added in v1.8.0 

func (o *AppUserInput) GetAppUserStatus() *AppUserStatusInput

func (*AppUserInput) GetAppUserType ¶ added in v1.8.0 

func (o *AppUserInput) GetAppUserType() *AppUserType

type AppUserServiceListCredentialsResponse ¶ added in v1.21.4 

type AppUserServiceListCredentialsResponse struct {
	// The list field.
	List []AppUserCredential `json:"list,omitempty"`
	// The nextPageToken field.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The AppUserServiceListCredentialsResponse message.

func (*AppUserServiceListCredentialsResponse) GetList ¶ added in v1.21.4 

func (o *AppUserServiceListCredentialsResponse) GetList() []AppUserCredential

func (*AppUserServiceListCredentialsResponse) GetNextPageToken ¶ added in v1.21.4 

func (o *AppUserServiceListCredentialsResponse) GetNextPageToken() *string

type AppUserServiceListResponse ¶ added in v1.21.4 

type AppUserServiceListResponse struct {
	// The expanded field.
	Expanded []AppUserServiceListResponseExpanded `json:"expanded,omitempty"`
	// The list field.
	List []AppUserView `json:"list,omitempty"`
	// The nextPageToken field.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The AppUserServiceListResponse message.

func (*AppUserServiceListResponse) GetExpanded ¶ added in v1.21.4 

func (o *AppUserServiceListResponse) GetExpanded() []AppUserServiceListResponseExpanded

func (*AppUserServiceListResponse) GetList ¶ added in v1.21.4 

func (o *AppUserServiceListResponse) GetList() []AppUserView

func (*AppUserServiceListResponse) GetNextPageToken ¶ added in v1.21.4 

func (o *AppUserServiceListResponse) GetNextPageToken() *string

type AppUserServiceListResponseExpanded ¶ added in v1.21.4 

type AppUserServiceListResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

AppUserServiceListResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*AppUserServiceListResponseExpanded) GetAdditionalProperties ¶ added in v1.21.4 

func (o *AppUserServiceListResponseExpanded) GetAdditionalProperties() map[string]any

func (*AppUserServiceListResponseExpanded) GetAtType ¶ added in v1.21.4 

func (o *AppUserServiceListResponseExpanded) GetAtType() *string

func (AppUserServiceListResponseExpanded) MarshalJSON ¶ added in v1.21.4 

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

func (*AppUserServiceListResponseExpanded) UnmarshalJSON ¶ added in v1.21.4 

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

type AppUserServiceUpdateRequest ¶ added in v1.15.0 

type AppUserServiceUpdateRequest struct {
	// Application User that represents an account in the application.
	AppUser *AppUserInput `json:"appUser,omitempty"`
	// The AppUserExpandMask message contains a list of paths to expand in the response.
	AppUserExpandMask *AppUserExpandMask `json:"expandMask,omitempty"`
	UpdateMask        *string            `json:"updateMask,omitempty"`
}

The AppUserServiceUpdateRequest message contains the app user and the fields to be updated.

func (*AppUserServiceUpdateRequest) GetAppUser ¶ added in v1.15.0 

func (o *AppUserServiceUpdateRequest) GetAppUser() *AppUserInput

func (*AppUserServiceUpdateRequest) GetAppUserExpandMask ¶ added in v1.15.0 

func (o *AppUserServiceUpdateRequest) GetAppUserExpandMask() *AppUserExpandMask

func (*AppUserServiceUpdateRequest) GetUpdateMask ¶ added in v1.15.0 

func (o *AppUserServiceUpdateRequest) GetUpdateMask() *string

type AppUserServiceUpdateResponse ¶ added in v1.8.0 

type AppUserServiceUpdateResponse struct {
	// The AppUserView contains an app user as well as paths for apps, identity users, and last usage in expanded arrays.
	AppUserView *AppUserView `json:"appUserView,omitempty"`
	// The expanded field.
	Expanded []AppUserServiceUpdateResponseExpanded `json:"expanded,omitempty"`
}

The AppUserServiceUpdateResponse message.

func (*AppUserServiceUpdateResponse) GetAppUserView ¶ added in v1.8.0 

func (o *AppUserServiceUpdateResponse) GetAppUserView() *AppUserView

func (*AppUserServiceUpdateResponse) GetExpanded ¶ added in v1.8.0 

func (o *AppUserServiceUpdateResponse) GetExpanded() []AppUserServiceUpdateResponseExpanded

type AppUserServiceUpdateResponseExpanded ¶ added in v1.10.1 

type AppUserServiceUpdateResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

AppUserServiceUpdateResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*AppUserServiceUpdateResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *AppUserServiceUpdateResponseExpanded) GetAdditionalProperties() map[string]any

func (*AppUserServiceUpdateResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *AppUserServiceUpdateResponseExpanded) GetAtType() *string

func (AppUserServiceUpdateResponseExpanded) MarshalJSON ¶ added in v1.10.1 

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

func (*AppUserServiceUpdateResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

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

type AppUserStatus ¶ added in v1.7.0 

type AppUserStatus struct {
	// The details of applicaiton user status.
	Details *string `json:"details,omitempty"`
	// The application user status field.
	Status *AppUserStatusStatus `json:"status,omitempty"`
}

AppUserStatus - The satus of the applicaiton user.

func (*AppUserStatus) GetDetails ¶ added in v1.7.0 

func (o *AppUserStatus) GetDetails() *string

func (*AppUserStatus) GetStatus ¶ added in v1.7.0 

func (o *AppUserStatus) GetStatus() *AppUserStatusStatus

type AppUserStatusInput ¶ added in v1.8.0 

type AppUserStatusInput struct {
}

AppUserStatusInput - The satus of the applicaiton user.

type AppUserStatusStatus ¶ added in v1.7.0 

type AppUserStatusStatus string

AppUserStatusStatus - The application user status field. 

const (
	AppUserStatusStatusStatusUnspecified AppUserStatusStatus = "STATUS_UNSPECIFIED"
	AppUserStatusStatusStatusEnabled     AppUserStatusStatus = "STATUS_ENABLED"
	AppUserStatusStatusStatusDisabled    AppUserStatusStatus = "STATUS_DISABLED"
	AppUserStatusStatusStatusDeleted     AppUserStatusStatus = "STATUS_DELETED"
)

func (AppUserStatusStatus) ToPointer ¶ added in v1.7.0 

func (e AppUserStatusStatus) ToPointer() *AppUserStatusStatus

type AppUserType ¶ added in v1.15.0 

type AppUserType string

AppUserType - The appplication user type. Type can be user, system or service. 

const (
	AppUserTypeAppUserTypeUnspecified    AppUserType = "APP_USER_TYPE_UNSPECIFIED"
	AppUserTypeAppUserTypeUser           AppUserType = "APP_USER_TYPE_USER"
	AppUserTypeAppUserTypeServiceAccount AppUserType = "APP_USER_TYPE_SERVICE_ACCOUNT"
	AppUserTypeAppUserTypeSystemAccount  AppUserType = "APP_USER_TYPE_SYSTEM_ACCOUNT"
)

func (AppUserType) ToPointer ¶ added in v1.15.0 

func (e AppUserType) ToPointer() *AppUserType

type AppUserView ¶ added in v1.7.0 

type AppUserView struct {
	// Application User that represents an account in the application.
	AppUser *AppUser `json:"appUser,omitempty"`
	// JSONPATH expression indicating where the app is expanded in expanded arrays indicated in the request.
	AppPath *string `json:"appPath,omitempty"`
	// JSONPATH expression indicating where the identity user is expanded in expanded arrays indicated in the request.
	IdentityUserPath *string `json:"identityUserPath,omitempty"`
	// JSONPATH expression indicating where the last usage information is expanded in expanded arrays indicated in the request.
	LastUsagePath *string `json:"lastUsagePath,omitempty"`
}

The AppUserView contains an app user as well as paths for apps, identity users, and last usage in expanded arrays.

func (*AppUserView) GetAppPath ¶ added in v1.7.0 

func (o *AppUserView) GetAppPath() *string

func (*AppUserView) GetAppUser ¶ added in v1.7.0 

func (o *AppUserView) GetAppUser() *AppUser

func (*AppUserView) GetIdentityUserPath ¶ added in v1.7.0 

func (o *AppUserView) GetIdentityUserPath() *string

func (*AppUserView) GetLastUsagePath ¶ added in v1.7.0 

func (o *AppUserView) GetLastUsagePath() *string

type Approval ¶ added in v1.0.3 

type Approval struct {
	// The AppGroupApproval object provides the configuration for setting a group as the approvers of an approval policy step.
	AppGroupApproval *AppGroupApproval `json:"group,omitempty"`
	// App owner approval provides the configuration for an approval step when the app owner is the target.
	AppOwnerApproval *AppOwnerApproval `json:"appOwners,omitempty"`
	// The entitlement owner approval allows configuration of the approval step when the target approvers are the entitlement owners.
	EntitlementOwnerApproval *EntitlementOwnerApproval `json:"entitlementOwners,omitempty"`
	// The ExpressionApproval message.
	ExpressionApproval *ExpressionApproval `json:"expression,omitempty"`
	// The manager approval object provides configuration options for approval when the target of the approval is the manager of the user in the task.
	ManagerApproval *ManagerApproval `json:"manager,omitempty"`
	// The resource owner approval allows configuration of the approval step when the target approvers are the resource owners.
	ResourceOwnerApproval *ResourceOwnerApproval `json:"resourceOwners,omitempty"`
	// The self approval object describes the configuration of a policy step that needs to be approved by the target of the request.
	SelfApproval *SelfApproval `json:"self,omitempty"`
	// The user approval object describes the approval configuration of a policy step that needs to be approved by a specific list of users.
	UserApproval *UserApproval `json:"users,omitempty"`
	// The WebhookApproval message.
	WebhookApproval *WebhookApproval `json:"webhook,omitempty"`
	// Configuration to allow reassignment by reviewers during this step.
	AllowReassignment *bool `json:"allowReassignment,omitempty"`
	// A field indicating whether this step is assigned.
	Assigned *bool `json:"assigned,omitempty"`
	// Configuration to require a reason when approving this step.
	RequireApprovalReason *bool `json:"requireApprovalReason,omitempty"`
	// Configuration to require a reason when denying this step.
	RequireDenialReason *bool `json:"requireDenialReason,omitempty"`
	// Configuration to require a reason when reassigning this step.
	RequireReassignmentReason *bool `json:"requireReassignmentReason,omitempty"`
}

The Approval message.

This message contains a oneof named typ. Only a single field of the following list may be set at a time:

  • users
  • manager
  • appOwners
  • group
  • self
  • entitlementOwners
  • expression
  • webhook
  • resourceOwners

func (*Approval) GetAllowReassignment ¶ added in v1.6.1 

func (o *Approval) GetAllowReassignment() *bool

func (*Approval) GetAppGroupApproval ¶ added in v1.6.1 

func (o *Approval) GetAppGroupApproval() *AppGroupApproval

func (*Approval) GetAppOwnerApproval ¶ added in v1.6.1 

func (o *Approval) GetAppOwnerApproval() *AppOwnerApproval

func (*Approval) GetAssigned ¶ added in v1.6.1 

func (o *Approval) GetAssigned() *bool

func (*Approval) GetEntitlementOwnerApproval ¶ added in v1.6.1 

func (o *Approval) GetEntitlementOwnerApproval() *EntitlementOwnerApproval

func (*Approval) GetExpressionApproval ¶ added in v1.9.0 

func (o *Approval) GetExpressionApproval() *ExpressionApproval

func (*Approval) GetManagerApproval ¶ added in v1.6.1 

func (o *Approval) GetManagerApproval() *ManagerApproval

func (*Approval) GetRequireApprovalReason ¶ added in v1.6.1 

func (o *Approval) GetRequireApprovalReason() *bool

func (*Approval) GetRequireDenialReason ¶ added in v1.18.3 

func (o *Approval) GetRequireDenialReason() *bool

func (*Approval) GetRequireReassignmentReason ¶ added in v1.6.1 

func (o *Approval) GetRequireReassignmentReason() *bool

func (*Approval) GetResourceOwnerApproval ¶ added in v1.20.0 

func (o *Approval) GetResourceOwnerApproval() *ResourceOwnerApproval

func (*Approval) GetSelfApproval ¶ added in v1.6.1 

func (o *Approval) GetSelfApproval() *SelfApproval

func (*Approval) GetUserApproval ¶ added in v1.6.1 

func (o *Approval) GetUserApproval() *UserApproval

func (*Approval) GetWebhookApproval ¶ added in v1.18.3 

func (o *Approval) GetWebhookApproval() *WebhookApproval

type ApprovalInput ¶ added in v1.7.0 

type ApprovalInput struct {
	// The AppGroupApproval object provides the configuration for setting a group as the approvers of an approval policy step.
	AppGroupApproval *AppGroupApproval `json:"group,omitempty"`
	// App owner approval provides the configuration for an approval step when the app owner is the target.
	AppOwnerApproval *AppOwnerApproval `json:"appOwners,omitempty"`
	// The entitlement owner approval allows configuration of the approval step when the target approvers are the entitlement owners.
	EntitlementOwnerApproval *EntitlementOwnerApproval `json:"entitlementOwners,omitempty"`
	// The ExpressionApproval message.
	ExpressionApproval *ExpressionApproval `json:"expression,omitempty"`
	// The manager approval object provides configuration options for approval when the target of the approval is the manager of the user in the task.
	ManagerApproval *ManagerApprovalInput `json:"manager,omitempty"`
	// The resource owner approval allows configuration of the approval step when the target approvers are the resource owners.
	ResourceOwnerApproval *ResourceOwnerApproval `json:"resourceOwners,omitempty"`
	// The self approval object describes the configuration of a policy step that needs to be approved by the target of the request.
	SelfApproval *SelfApproval `json:"self,omitempty"`
	// The user approval object describes the approval configuration of a policy step that needs to be approved by a specific list of users.
	UserApproval *UserApproval `json:"users,omitempty"`
	// The WebhookApproval message.
	WebhookApproval *WebhookApproval `json:"webhook,omitempty"`
	// Configuration to allow reassignment by reviewers during this step.
	AllowReassignment *bool `json:"allowReassignment,omitempty"`
	// A field indicating whether this step is assigned.
	Assigned *bool `json:"assigned,omitempty"`
	// Configuration to require a reason when approving this step.
	RequireApprovalReason *bool `json:"requireApprovalReason,omitempty"`
	// Configuration to require a reason when denying this step.
	RequireDenialReason *bool `json:"requireDenialReason,omitempty"`
	// Configuration to require a reason when reassigning this step.
	RequireReassignmentReason *bool `json:"requireReassignmentReason,omitempty"`
}

ApprovalInput - The Approval message.

This message contains a oneof named typ. Only a single field of the following list may be set at a time:

  • users
  • manager
  • appOwners
  • group
  • self
  • entitlementOwners
  • expression
  • webhook
  • resourceOwners

func (*ApprovalInput) GetAllowReassignment ¶ added in v1.21.3 

func (o *ApprovalInput) GetAllowReassignment() *bool

func (*ApprovalInput) GetAppGroupApproval ¶ added in v1.7.0 

func (o *ApprovalInput) GetAppGroupApproval() *AppGroupApproval

func (*ApprovalInput) GetAppOwnerApproval ¶ added in v1.7.0 

func (o *ApprovalInput) GetAppOwnerApproval() *AppOwnerApproval

func (*ApprovalInput) GetAssigned ¶ added in v1.21.3 

func (o *ApprovalInput) GetAssigned() *bool

func (*ApprovalInput) GetEntitlementOwnerApproval ¶ added in v1.7.0 

func (o *ApprovalInput) GetEntitlementOwnerApproval() *EntitlementOwnerApproval

func (*ApprovalInput) GetExpressionApproval ¶ added in v1.9.0 

func (o *ApprovalInput) GetExpressionApproval() *ExpressionApproval

func (*ApprovalInput) GetManagerApproval ¶ added in v1.7.0 

func (o *ApprovalInput) GetManagerApproval() *ManagerApprovalInput

func (*ApprovalInput) GetRequireApprovalReason ¶ added in v1.21.3 

func (o *ApprovalInput) GetRequireApprovalReason() *bool

func (*ApprovalInput) GetRequireDenialReason ¶ added in v1.21.3 

func (o *ApprovalInput) GetRequireDenialReason() *bool

func (*ApprovalInput) GetRequireReassignmentReason ¶ added in v1.21.3 

func (o *ApprovalInput) GetRequireReassignmentReason() *bool

func (*ApprovalInput) GetResourceOwnerApproval ¶ added in v1.21.3 

func (o *ApprovalInput) GetResourceOwnerApproval() *ResourceOwnerApproval

func (*ApprovalInput) GetSelfApproval ¶ added in v1.7.0 

func (o *ApprovalInput) GetSelfApproval() *SelfApproval

func (*ApprovalInput) GetUserApproval ¶ added in v1.7.0 

func (o *ApprovalInput) GetUserApproval() *UserApproval

func (*ApprovalInput) GetWebhookApproval ¶ added in v1.21.3 

func (o *ApprovalInput) GetWebhookApproval() *WebhookApproval

type ApprovalInstance ¶ added in v1.0.3 

type ApprovalInstance struct {
	// The Approval message.
	//
	// This message contains a oneof named typ. Only a single field of the following list may be set at a time:
	//   - users
	//   - manager
	//   - appOwners
	//   - group
	//   - self
	//   - entitlementOwners
	//   - expression
	//   - webhook
	//   - resourceOwners
	//
	Approval *Approval `json:"approval,omitempty"`
	// The approved action indicates that the approvalinstance had an outcome of approved.
	ApprovedAction *ApprovedAction `json:"approved,omitempty"`
	// The denied action indicates that the c1.api.policy.v1.ApprovalInstance had an outcome of denied.
	DeniedAction *DeniedAction `json:"denied,omitempty"`
	// The ReassignedAction object describes the outcome of a policy step that has been reassigned.
	ReassignedAction *ReassignedAction `json:"reassigned,omitempty"`
	// The ReassignedByErrorAction object describes the outcome of a policy step that has been reassigned because it had an error provisioning.
	ReassignedByErrorAction *ReassignedByErrorAction `json:"reassignedByError,omitempty"`
	// The restart action describes the outcome of policy steps for when the task was restarted. This can be applied to multiple steps since restart skips all pending next steps.
	RestartAction *RestartAction `json:"restarted,omitempty"`
	// The state of the approval instance
	State *ApprovalInstanceState `json:"state,omitempty"`
}

ApprovalInstance - The approval instance object describes the way a policy step should be approved as well as its outcomes and state.

This message contains a oneof named outcome. Only a single field of the following list may be set at a time:

  • approved
  • denied
  • reassigned
  • restarted
  • reassignedByError

func (*ApprovalInstance) GetApproval ¶ added in v1.6.1 

func (o *ApprovalInstance) GetApproval() *Approval

func (*ApprovalInstance) GetApprovedAction ¶ added in v1.6.1 

func (o *ApprovalInstance) GetApprovedAction() *ApprovedAction

func (*ApprovalInstance) GetDeniedAction ¶ added in v1.6.1 

func (o *ApprovalInstance) GetDeniedAction() *DeniedAction

func (*ApprovalInstance) GetReassignedAction ¶ added in v1.6.1 

func (o *ApprovalInstance) GetReassignedAction() *ReassignedAction

func (*ApprovalInstance) GetReassignedByErrorAction ¶ added in v1.6.1 

func (o *ApprovalInstance) GetReassignedByErrorAction() *ReassignedByErrorAction

func (*ApprovalInstance) GetRestartAction ¶ added in v1.6.1 

func (o *ApprovalInstance) GetRestartAction() *RestartAction

func (*ApprovalInstance) GetState ¶ added in v1.6.1 

func (o *ApprovalInstance) GetState() *ApprovalInstanceState

type ApprovalInstanceState ¶ added in v1.0.3 

type ApprovalInstanceState string

ApprovalInstanceState - The state of the approval instance 

const (
	ApprovalInstanceStateApprovalInstanceStateUnspecified          ApprovalInstanceState = "APPROVAL_INSTANCE_STATE_UNSPECIFIED"
	ApprovalInstanceStateApprovalInstanceStateInit                 ApprovalInstanceState = "APPROVAL_INSTANCE_STATE_INIT"
	ApprovalInstanceStateApprovalInstanceStateSendingNotifications ApprovalInstanceState = "APPROVAL_INSTANCE_STATE_SENDING_NOTIFICATIONS"
	ApprovalInstanceStateApprovalInstanceStateWaiting              ApprovalInstanceState = "APPROVAL_INSTANCE_STATE_WAITING"
	ApprovalInstanceStateApprovalInstanceStateDone                 ApprovalInstanceState = "APPROVAL_INSTANCE_STATE_DONE"
)

func (ApprovalInstanceState) ToPointer ¶ added in v1.0.3 

func (e ApprovalInstanceState) ToPointer() *ApprovalInstanceState

type ApprovedAction ¶ added in v1.0.3 

type ApprovedAction struct {
	ApprovedAt *time.Time `json:"approvedAt,omitempty"`
	// The entitlements that were approved. This will only ever be a list of one entitlement.
	Entitlements []AppEntitlementReference `json:"entitlements,omitempty"`
	// The UserID that approved this step.
	UserID *string `json:"userId,omitempty"`
}

ApprovedAction - The approved action indicates that the approvalinstance had an outcome of approved.

func (*ApprovedAction) GetApprovedAt ¶ added in v1.6.1 

func (o *ApprovedAction) GetApprovedAt() *time.Time

func (*ApprovedAction) GetEntitlements ¶ added in v1.6.1 

func (o *ApprovedAction) GetEntitlements() []AppEntitlementReference

func (*ApprovedAction) GetUserID ¶ added in v1.6.1 

func (o *ApprovedAction) GetUserID() *string

func (ApprovedAction) MarshalJSON ¶ added in v1.10.1 

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

func (*ApprovedAction) UnmarshalJSON ¶ added in v1.10.1 

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

type AttributeType ¶ added in v1.8.0 

type AttributeType struct {
	// The ID of the AttributeType.
	ID *string `json:"id,omitempty"`
	// The name of the AttributeType.
	Name *string `json:"name,omitempty"`
}

AttributeType defines the type of an attribute.

func (*AttributeType) GetID ¶ added in v1.8.0 

func (o *AttributeType) GetID() *string

func (*AttributeType) GetName ¶ added in v1.8.0 

func (o *AttributeType) GetName() *string

type AttributeValue ¶ added in v1.8.0 

type AttributeValue struct {
	// The ID of the AttributeType that this AttributeValue belongs to.
	AttributeTypeID *string    `json:"attributeTypeId,omitempty"`
	CreatedAt       *time.Time `json:"createdAt,omitempty"`
	DeletedAt       *time.Time `json:"deletedAt,omitempty"`
	// The ID of the AttributeValue.
	ID        *string    `json:"id,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	// The value of the AttributeValue. This is the string that will be displayed to the user.
	Value *string `json:"value,omitempty"`
}

AttributeValue is the value of an attribute of a defined type.

func (*AttributeValue) GetAttributeTypeID ¶ added in v1.8.0 

func (o *AttributeValue) GetAttributeTypeID() *string

func (*AttributeValue) GetCreatedAt ¶ added in v1.8.0 

func (o *AttributeValue) GetCreatedAt() *time.Time

func (*AttributeValue) GetDeletedAt ¶ added in v1.8.0 

func (o *AttributeValue) GetDeletedAt() *time.Time

func (*AttributeValue) GetID ¶ added in v1.8.0 

func (o *AttributeValue) GetID() *string

func (*AttributeValue) GetUpdatedAt ¶ added in v1.8.0 

func (o *AttributeValue) GetUpdatedAt() *time.Time

func (*AttributeValue) GetValue ¶ added in v1.8.0 

func (o *AttributeValue) GetValue() *string

func (AttributeValue) MarshalJSON ¶ added in v1.10.1 

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

func (*AttributeValue) UnmarshalJSON ¶ added in v1.10.1 

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

type Body ¶ added in v1.19.0 

type Body struct {
	// If your receiver returns HTTP Status Code 202 Accepted, it MUST send its resposne to this URL as a POST
	//  message body.
	//
	//  If your receiver returns any other status code, it is expected to not use the callback url.
	//
	//  This value will match the "Webhook-Callback-Url" header.
	CallbackURL *string `json:"callbackUrl,omitempty"`
	// The type of event that triggered this Webhook.
	//
	//  This value will match the "Webhook-Event" header.
	//
	//  The value will be one of:
	//  - "c1.webhooks.v1.PayloadTest"
	//  - "c1.webhooks.v1.PayloadPolicyApprovalStep"
	//  - "c1.webhooks.v1.PayloadPolicyPostAction"
	//  - "c1.webhooks.v1.PayloadProvisionStep"
	Event *string `json:"event,omitempty"`
	// Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
	Payload *Payload `json:"payload,omitempty"`
	// version contains the constant value "v1". Future versions of the Webhook body will use a different string.
	//
	//  This value will match the "Webhook-Version" header.
	Version *string `json:"version,omitempty"`
	// Unique ID for this Webhook. Your receiver should only process this ID once.
	//
	//  This value will match the "Webhook-Id" header.
	WebhookID *string `json:"webhookId,omitempty"`
}

The Body message.

func (*Body) GetCallbackURL ¶ added in v1.19.0 

func (o *Body) GetCallbackURL() *string

func (*Body) GetEvent ¶ added in v1.19.0 

func (o *Body) GetEvent() *string

func (*Body) GetPayload ¶ added in v1.19.0 

func (o *Body) GetPayload() *Payload

func (*Body) GetVersion ¶ added in v1.19.0 

func (o *Body) GetVersion() *string

func (*Body) GetWebhookID ¶ added in v1.19.0 

func (o *Body) GetWebhookID() *string

type BundleAutomation ¶ added in v1.18.3 

type BundleAutomation struct {
	// The BundleAutomationLastRunState message.
	BundleAutomationLastRunState *BundleAutomationLastRunState `json:"state,omitempty"`
	// The BundleAutomationRuleEntitlement message.
	BundleAutomationRuleEntitlement *BundleAutomationRuleEntitlement `json:"entitlements,omitempty"`
	// The createTasks field.
	CreateTasks *bool      `json:"createTasks,omitempty"`
	CreatedAt   *time.Time `json:"createdAt,omitempty"`
	DeletedAt   *time.Time `json:"deletedAt,omitempty"`
	// The enabled field.
	Enabled *bool `json:"enabled,omitempty"`
	// The requestCatalogId field.
	RequestCatalogID *string `json:"requestCatalogId,omitempty"`
	// The tenantId field.
	TenantID  *string    `json:"tenantId,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}

The BundleAutomation message.

This message contains a oneof named conditions. Only a single field of the following list may be set at a time:

  • entitlements

func (*BundleAutomation) GetBundleAutomationLastRunState ¶ added in v1.18.3 

func (o *BundleAutomation) GetBundleAutomationLastRunState() *BundleAutomationLastRunState

func (*BundleAutomation) GetBundleAutomationRuleEntitlement ¶ added in v1.18.3 

func (o *BundleAutomation) GetBundleAutomationRuleEntitlement() *BundleAutomationRuleEntitlement

func (*BundleAutomation) GetCreateTasks ¶ added in v1.21.3 

func (o *BundleAutomation) GetCreateTasks() *bool

func (*BundleAutomation) GetCreatedAt ¶ added in v1.18.3 

func (o *BundleAutomation) GetCreatedAt() *time.Time

func (*BundleAutomation) GetDeletedAt ¶ added in v1.18.3 

func (o *BundleAutomation) GetDeletedAt() *time.Time

func (*BundleAutomation) GetEnabled ¶ added in v1.20.0 

func (o *BundleAutomation) GetEnabled() *bool

func (*BundleAutomation) GetRequestCatalogID ¶ added in v1.18.3 

func (o *BundleAutomation) GetRequestCatalogID() *string

func (*BundleAutomation) GetTenantID ¶ added in v1.18.3 

func (o *BundleAutomation) GetTenantID() *string

func (*BundleAutomation) GetUpdatedAt ¶ added in v1.18.3 

func (o *BundleAutomation) GetUpdatedAt() *time.Time

func (BundleAutomation) MarshalJSON ¶ added in v1.18.3 

func (b BundleAutomation) MarshalJSON() ([]byte, error)

func (*BundleAutomation) UnmarshalJSON ¶ added in v1.18.3 

func (b *BundleAutomation) UnmarshalJSON(data []byte) error

type BundleAutomationLastRunState ¶ added in v1.18.3 

type BundleAutomationLastRunState struct {
	// The errorMessage field.
	ErrorMessage *string    `json:"errorMessage,omitempty"`
	LastRunAt    *time.Time `json:"lastRunAt,omitempty"`
	// The status field.
	Status *BundleAutomationLastRunStateStatus `json:"status,omitempty"`
}

The BundleAutomationLastRunState message.

func (*BundleAutomationLastRunState) GetErrorMessage ¶ added in v1.21.4 

func (o *BundleAutomationLastRunState) GetErrorMessage() *string

func (*BundleAutomationLastRunState) GetLastRunAt ¶ added in v1.18.3 

func (o *BundleAutomationLastRunState) GetLastRunAt() *time.Time

func (*BundleAutomationLastRunState) GetStatus ¶ added in v1.18.3 

func (o *BundleAutomationLastRunState) GetStatus() *BundleAutomationLastRunStateStatus

func (BundleAutomationLastRunState) MarshalJSON ¶ added in v1.18.3 

func (b BundleAutomationLastRunState) MarshalJSON() ([]byte, error)

func (*BundleAutomationLastRunState) UnmarshalJSON ¶ added in v1.18.3 

func (b *BundleAutomationLastRunState) UnmarshalJSON(data []byte) error

type BundleAutomationLastRunStateStatus ¶ added in v1.18.3 

type BundleAutomationLastRunStateStatus string

BundleAutomationLastRunStateStatus - The status field. 

const (
	BundleAutomationLastRunStateStatusBundleAutomationRunStatusUnspecified BundleAutomationLastRunStateStatus = "BUNDLE_AUTOMATION_RUN_STATUS_UNSPECIFIED"
	BundleAutomationLastRunStateStatusBundleAutomationRunStatusSuccess     BundleAutomationLastRunStateStatus = "BUNDLE_AUTOMATION_RUN_STATUS_SUCCESS"
	BundleAutomationLastRunStateStatusBundleAutomationRunStatusFailure     BundleAutomationLastRunStateStatus = "BUNDLE_AUTOMATION_RUN_STATUS_FAILURE"
	BundleAutomationLastRunStateStatusBundleAutomationRunStatusInProgress  BundleAutomationLastRunStateStatus = "BUNDLE_AUTOMATION_RUN_STATUS_IN_PROGRESS"
)

func (BundleAutomationLastRunStateStatus) ToPointer ¶ added in v1.18.3 

func (e BundleAutomationLastRunStateStatus) ToPointer() *BundleAutomationLastRunStateStatus

type BundleAutomationRuleEntitlement ¶ added in v1.18.3 

type BundleAutomationRuleEntitlement struct {
	// The entitlementRefs field.
	EntitlementRefs []AppEntitlementRef `json:"entitlementRefs,omitempty"`
}

The BundleAutomationRuleEntitlement message.

func (*BundleAutomationRuleEntitlement) GetEntitlementRefs ¶ added in v1.18.3 

func (o *BundleAutomationRuleEntitlement) GetEntitlementRefs() []AppEntitlementRef

type CIDRRestriction ¶ added in v1.21.4 

type CIDRRestriction struct {
	// The enabled field.
	Enabled *bool `json:"enabled,omitempty"`
	// The sourceCidr field.
	SourceCidr []string `json:"sourceCidr,omitempty"`
}

The CIDRRestriction message.

func (*CIDRRestriction) GetEnabled ¶ added in v1.21.4 

func (o *CIDRRestriction) GetEnabled() *bool

func (*CIDRRestriction) GetSourceCidr ¶ added in v1.21.4 

func (o *CIDRRestriction) GetSourceCidr() []string

type CancelAccessRequestDefaultsRequest ¶ added in v1.18.3 

type CancelAccessRequestDefaultsRequest struct {
}

The CancelAccessRequestDefaultsRequest message.

type CancelledAction ¶ added in v1.0.3 

type CancelledAction struct {
	CancelledAt *time.Time `json:"cancelledAt,omitempty"`
	// The userID, usually the system, that cancells a provision instance.
	CancelledByUserID *string `json:"cancelledByUserId,omitempty"`
}

CancelledAction - The outcome of a provision instance that is cancelled.

func (*CancelledAction) GetCancelledAt ¶ added in v1.6.1 

func (o *CancelledAction) GetCancelledAt() *time.Time

func (*CancelledAction) GetCancelledByUserID ¶ added in v1.6.1 

func (o *CancelledAction) GetCancelledByUserID() *string

func (CancelledAction) MarshalJSON ¶ added in v1.10.1 

func (c CancelledAction) MarshalJSON() ([]byte, error)

func (*CancelledAction) UnmarshalJSON ¶ added in v1.10.1 

func (c *CancelledAction) UnmarshalJSON(data []byte) error

type CompletedAction ¶ added in v1.0.3 

type CompletedAction struct {
	CompletedAt *time.Time `json:"completedAt,omitempty"`
	// The list of entitlements that were provisioned. This is leftover from an older design, and is only ever going to be a single entitlement.
	Entitlements []AppEntitlementReference `json:"entitlements,omitempty"`
	// The UserID of who completed provisioning. For connector provisioning this is the system user id, for manual provisioning this is who clicked "provision complete"
	UserID *string `json:"userId,omitempty"`
}

CompletedAction - The outcome of a provision instance that has been completed succesfully.

func (*CompletedAction) GetCompletedAt ¶ added in v1.6.1 

func (o *CompletedAction) GetCompletedAt() *time.Time

func (*CompletedAction) GetEntitlements ¶ added in v1.6.1 

func (o *CompletedAction) GetEntitlements() []AppEntitlementReference

func (*CompletedAction) GetUserID ¶ added in v1.6.1 

func (o *CompletedAction) GetUserID() *string

func (CompletedAction) MarshalJSON ¶ added in v1.10.1 

func (c CompletedAction) MarshalJSON() ([]byte, error)

func (*CompletedAction) UnmarshalJSON ¶ added in v1.10.1 

func (c *CompletedAction) UnmarshalJSON(data []byte) error

type ConditionSucceeded ¶ added in v1.18.3 

type ConditionSucceeded struct {
	SucceededAt *time.Time `json:"succeededAt,omitempty"`
}

The ConditionSucceeded message.

func (*ConditionSucceeded) GetSucceededAt ¶ added in v1.18.3 

func (o *ConditionSucceeded) GetSucceededAt() *time.Time

func (ConditionSucceeded) MarshalJSON ¶ added in v1.18.3 

func (c ConditionSucceeded) MarshalJSON() ([]byte, error)

func (*ConditionSucceeded) UnmarshalJSON ¶ added in v1.18.3 

func (c *ConditionSucceeded) UnmarshalJSON(data []byte) error

type ConditionTimedOut ¶ added in v1.18.3 

type ConditionTimedOut struct {
	TimedOutAt *time.Time `json:"timedOutAt,omitempty"`
}

The ConditionTimedOut message.

func (*ConditionTimedOut) GetTimedOutAt ¶ added in v1.18.3 

func (o *ConditionTimedOut) GetTimedOutAt() *time.Time

func (ConditionTimedOut) MarshalJSON ¶ added in v1.18.3 

func (c ConditionTimedOut) MarshalJSON() ([]byte, error)

func (*ConditionTimedOut) UnmarshalJSON ¶ added in v1.18.3 

func (c *ConditionTimedOut) UnmarshalJSON(data []byte) error

type Config ¶ added in v1.15.0 

type Config struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

Config - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*Config) GetAdditionalProperties ¶ added in v1.15.0 

func (o *Config) GetAdditionalProperties() map[string]any

func (*Config) GetAtType ¶ added in v1.15.0 

func (o *Config) GetAtType() *string

func (Config) MarshalJSON ¶ added in v1.15.0 

func (c Config) MarshalJSON() ([]byte, error)

func (*Config) UnmarshalJSON ¶ added in v1.15.0 

func (c *Config) UnmarshalJSON(data []byte) error

type Connector ¶ added in v1.7.0 

type Connector struct {
	// The status field on the connector is used to track the status of the connectors sync, and when syncing last started, completed, or caused the connector to update.
	ConnectorStatus *ConnectorStatus `json:"status,omitempty"`
	// OAuth2AuthorizedAs tracks the user that OAuthed with the connector.
	OAuth2AuthorizedAs *OAuth2AuthorizedAs `json:"oauthAuthorizedAs,omitempty"`
	// The id of the app the connector is associated with.
	AppID *string `json:"appId,omitempty"`
	// The catalogId describes which catalog entry this connector is an instance of. For example, every Okta connector will have the same catalogId indicating it is an Okta connector.
	CatalogID *string `json:"catalogId,omitempty"`
	// Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
	Config    *Config    `json:"config,omitempty"`
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
	// The description of the connector.
	Description *string `json:"description,omitempty"`
	// The display name of the connector.
	DisplayName *string `json:"displayName,omitempty"`
	// The downloadUrl for a spreadsheet if the connector was created from uploading a file.
	DownloadURL *string `json:"downloadUrl,omitempty"`
	// The id of the connector.
	ID        *string    `json:"id,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	// The userIds field is used to define the integration owners of the connector.
	UserIds []string `json:"userIds,omitempty"`
}

A Connector is used to sync objects into Apps

func (*Connector) GetAppID ¶ added in v1.7.0 

func (o *Connector) GetAppID() *string

func (*Connector) GetCatalogID ¶ added in v1.7.0 

func (o *Connector) GetCatalogID() *string

func (*Connector) GetConfig ¶ added in v1.7.0 

func (o *Connector) GetConfig() *Config

func (*Connector) GetConnectorStatus ¶ added in v1.7.0 

func (o *Connector) GetConnectorStatus() *ConnectorStatus

func (*Connector) GetCreatedAt ¶ added in v1.7.0 

func (o *Connector) GetCreatedAt() *time.Time

func (*Connector) GetDeletedAt ¶ added in v1.7.0 

func (o *Connector) GetDeletedAt() *time.Time

func (*Connector) GetDescription ¶ added in v1.7.0 

func (o *Connector) GetDescription() *string

func (*Connector) GetDisplayName ¶ added in v1.7.0 

func (o *Connector) GetDisplayName() *string

func (*Connector) GetDownloadURL ¶ added in v1.7.0 

func (o *Connector) GetDownloadURL() *string

func (*Connector) GetID ¶ added in v1.7.0 

func (o *Connector) GetID() *string

func (*Connector) GetOAuth2AuthorizedAs ¶ added in v1.7.0 

func (o *Connector) GetOAuth2AuthorizedAs() *OAuth2AuthorizedAs

func (*Connector) GetUpdatedAt ¶ added in v1.7.0 

func (o *Connector) GetUpdatedAt() *time.Time

func (*Connector) GetUserIds ¶ added in v1.7.0 

func (o *Connector) GetUserIds() []string

func (Connector) MarshalJSON ¶ added in v1.10.1 

func (c Connector) MarshalJSON() ([]byte, error)

func (*Connector) UnmarshalJSON ¶ added in v1.10.1 

func (c *Connector) UnmarshalJSON(data []byte) error

type ConnectorCredential ¶ added in v1.7.0 

type ConnectorCredential struct {
	// The appId of the app the connector is attached to.
	AppID *string `json:"appId,omitempty"`
	// The client id of the ConnectorCredential.
	ClientID *string `json:"clientId,omitempty"`
	// The connectorId of the connector the credential is associated with.
	ConnectorID *string    `json:"connectorId,omitempty"`
	CreatedAt   *time.Time `json:"createdAt,omitempty"`
	DeletedAt   *time.Time `json:"deletedAt,omitempty"`
	// The display name of the ConnectorCredential.
	DisplayName *string    `json:"displayName,omitempty"`
	ExpiresTime *time.Time `json:"expiresTime,omitempty"`
	// The id of the ConnectorCredential.
	ID         *string    `json:"id,omitempty"`
	LastUsedAt *time.Time `json:"lastUsedAt,omitempty"`
	UpdatedAt  *time.Time `json:"updatedAt,omitempty"`
}

ConnectorCredential is used by a connector to authenticate with conductor one.

func (*ConnectorCredential) GetAppID ¶ added in v1.7.0 

func (o *ConnectorCredential) GetAppID() *string

func (*ConnectorCredential) GetClientID ¶ added in v1.7.0 

func (o *ConnectorCredential) GetClientID() *string

func (*ConnectorCredential) GetConnectorID ¶ added in v1.7.0 

func (o *ConnectorCredential) GetConnectorID() *string

func (*ConnectorCredential) GetCreatedAt ¶ added in v1.7.0 

func (o *ConnectorCredential) GetCreatedAt() *time.Time

func (*ConnectorCredential) GetDeletedAt ¶ added in v1.7.0 

func (o *ConnectorCredential) GetDeletedAt() *time.Time

func (*ConnectorCredential) GetDisplayName ¶ added in v1.7.0 

func (o *ConnectorCredential) GetDisplayName() *string

func (*ConnectorCredential) GetExpiresTime ¶ added in v1.7.0 

func (o *ConnectorCredential) GetExpiresTime() *time.Time

func (*ConnectorCredential) GetID ¶ added in v1.7.0 

func (o *ConnectorCredential) GetID() *string

func (*ConnectorCredential) GetLastUsedAt ¶ added in v1.7.0 

func (o *ConnectorCredential) GetLastUsedAt() *time.Time

func (*ConnectorCredential) GetUpdatedAt ¶ added in v1.7.0 

func (o *ConnectorCredential) GetUpdatedAt() *time.Time

func (ConnectorCredential) MarshalJSON ¶ added in v1.10.1 

func (c ConnectorCredential) MarshalJSON() ([]byte, error)

func (*ConnectorCredential) UnmarshalJSON ¶ added in v1.10.1 

func (c *ConnectorCredential) UnmarshalJSON(data []byte) error

type ConnectorExpandMask ¶ added in v1.7.0 

type ConnectorExpandMask struct {
	// Paths that you want expanded in the response. Possible values are "app_id" and "*".
	Paths []string `json:"paths,omitempty"`
}

The ConnectorExpandMask is used to expand related objects on a connector.

func (*ConnectorExpandMask) GetPaths ¶ added in v1.7.0 

func (o *ConnectorExpandMask) GetPaths() []string

type ConnectorInput ¶ added in v1.7.0 

type ConnectorInput struct {
	// The status field on the connector is used to track the status of the connectors sync, and when syncing last started, completed, or caused the connector to update.
	ConnectorStatus *ConnectorStatus `json:"status,omitempty"`
	// OAuth2AuthorizedAs tracks the user that OAuthed with the connector.
	OAuth2AuthorizedAs *OAuth2AuthorizedAsInput `json:"oauthAuthorizedAs,omitempty"`
	// The id of the app the connector is associated with.
	AppID *string `json:"appId,omitempty"`
	// Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
	Config *Config `json:"config,omitempty"`
	// The description of the connector.
	Description *string `json:"description,omitempty"`
	// The display name of the connector.
	DisplayName *string `json:"displayName,omitempty"`
	// The id of the connector.
	ID *string `json:"id,omitempty"`
	// The userIds field is used to define the integration owners of the connector.
	UserIds []string `json:"userIds,omitempty"`
}

ConnectorInput - A Connector is used to sync objects into Apps

func (*ConnectorInput) GetAppID ¶ added in v1.7.0 

func (o *ConnectorInput) GetAppID() *string

func (*ConnectorInput) GetConfig ¶ added in v1.7.0 

func (o *ConnectorInput) GetConfig() *Config

func (*ConnectorInput) GetConnectorStatus ¶ added in v1.7.0 

func (o *ConnectorInput) GetConnectorStatus() *ConnectorStatus

func (*ConnectorInput) GetDescription ¶ added in v1.7.0 

func (o *ConnectorInput) GetDescription() *string

func (*ConnectorInput) GetDisplayName ¶ added in v1.7.0 

func (o *ConnectorInput) GetDisplayName() *string

func (*ConnectorInput) GetID ¶ added in v1.7.0 

func (o *ConnectorInput) GetID() *string

func (*ConnectorInput) GetOAuth2AuthorizedAs ¶ added in v1.7.0 

func (o *ConnectorInput) GetOAuth2AuthorizedAs() *OAuth2AuthorizedAsInput

func (*ConnectorInput) GetUserIds ¶ added in v1.7.0 

func (o *ConnectorInput) GetUserIds() []string

type ConnectorProvision ¶ added in v1.0.3 

type ConnectorProvision struct {
}

ConnectorProvision - Indicates that a connector should perform the provisioning. This object has no fields.

type ConnectorServiceCreateDelegatedRequest ¶ added in v1.7.0 

type ConnectorServiceCreateDelegatedRequest struct {
	// The AppManagedStateBindingRef message.
	AppManagedStateBindingRef *AppManagedStateBindingRef `json:"appManagedStateBindingRef,omitempty"`
	// The ConnectorExpandMask is used to expand related objects on a connector.
	ConnectorExpandMask *ConnectorExpandMask `json:"expandMask,omitempty"`
	// The catalogId describes which catalog entry this connector is an instance of. For example, every Okta connector will have the same catalogId indicating it is an Okta connector.
	CatalogID *string `json:"catalogId,omitempty"`
	// The description of the connector.
	Description *string `json:"description,omitempty"`
	// The displayName of the connector.
	DisplayName *string `json:"displayName,omitempty"`
	// The userIds field is used to define the integration owners of the connector.
	UserIds []string `json:"userIds,omitempty"`
}

The ConnectorServiceCreateDelegatedRequest message contains the fields required to create a connector.

func (*ConnectorServiceCreateDelegatedRequest) GetAppManagedStateBindingRef ¶ added in v1.20.0 

func (o *ConnectorServiceCreateDelegatedRequest) GetAppManagedStateBindingRef() *AppManagedStateBindingRef

func (*ConnectorServiceCreateDelegatedRequest) GetCatalogID ¶ added in v1.7.0 

func (o *ConnectorServiceCreateDelegatedRequest) GetCatalogID() *string

func (*ConnectorServiceCreateDelegatedRequest) GetConnectorExpandMask ¶ added in v1.7.0 

func (o *ConnectorServiceCreateDelegatedRequest) GetConnectorExpandMask() *ConnectorExpandMask

func (*ConnectorServiceCreateDelegatedRequest) GetDescription ¶ added in v1.7.0 

func (o *ConnectorServiceCreateDelegatedRequest) GetDescription() *string

func (*ConnectorServiceCreateDelegatedRequest) GetDisplayName ¶ added in v1.7.0 

func (o *ConnectorServiceCreateDelegatedRequest) GetDisplayName() *string

func (*ConnectorServiceCreateDelegatedRequest) GetUserIds ¶ added in v1.7.0 

func (o *ConnectorServiceCreateDelegatedRequest) GetUserIds() []string

type ConnectorServiceCreateRequest ¶ added in v1.7.1 

type ConnectorServiceCreateRequest struct {
	// The ConnectorExpandMask is used to expand related objects on a connector.
	ConnectorExpandMask *ConnectorExpandMask `json:"expandMask,omitempty"`
	// The catalogId field.
	CatalogID *string `json:"catalogId,omitempty"`
	// Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
	Config *ConnectorServiceCreateRequestConfig `json:"config,omitempty"`
	// The description field.
	Description *string `json:"description,omitempty"`
	// The userIds field.
	UserIds []string `json:"userIds,omitempty"`
}

The ConnectorServiceCreateRequest message.

func (*ConnectorServiceCreateRequest) GetCatalogID ¶ added in v1.7.1 

func (o *ConnectorServiceCreateRequest) GetCatalogID() *string

func (*ConnectorServiceCreateRequest) GetConfig ¶ added in v1.7.1 

func (o *ConnectorServiceCreateRequest) GetConfig() *ConnectorServiceCreateRequestConfig

func (*ConnectorServiceCreateRequest) GetConnectorExpandMask ¶ added in v1.7.1 

func (o *ConnectorServiceCreateRequest) GetConnectorExpandMask() *ConnectorExpandMask

func (*ConnectorServiceCreateRequest) GetDescription ¶ added in v1.7.1 

func (o *ConnectorServiceCreateRequest) GetDescription() *string

func (*ConnectorServiceCreateRequest) GetUserIds ¶ added in v1.7.1 

func (o *ConnectorServiceCreateRequest) GetUserIds() []string

type ConnectorServiceCreateRequestConfig ¶ added in v1.10.1 

type ConnectorServiceCreateRequestConfig struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

ConnectorServiceCreateRequestConfig - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*ConnectorServiceCreateRequestConfig) GetAdditionalProperties ¶ added in v1.10.1 

func (o *ConnectorServiceCreateRequestConfig) GetAdditionalProperties() map[string]any

func (*ConnectorServiceCreateRequestConfig) GetAtType ¶ added in v1.10.1 

func (o *ConnectorServiceCreateRequestConfig) GetAtType() *string

func (ConnectorServiceCreateRequestConfig) MarshalJSON ¶ added in v1.10.1 

func (c ConnectorServiceCreateRequestConfig) MarshalJSON() ([]byte, error)

func (*ConnectorServiceCreateRequestConfig) UnmarshalJSON ¶ added in v1.10.1 

func (c *ConnectorServiceCreateRequestConfig) UnmarshalJSON(data []byte) error

type ConnectorServiceCreateResponse ¶ added in v1.7.0 

type ConnectorServiceCreateResponse struct {
	// The ConnectorView object provides a connector response object, as well as JSONPATHs to related objects provided by expanders.
	ConnectorView *ConnectorView `json:"connectorView,omitempty"`
	// The array of expanded items indicated by the request.
	Expanded []ConnectorServiceCreateResponseExpanded `json:"expanded,omitempty"`
}

The ConnectorServiceCreateResponse is the response returned from creating a connector.

func (*ConnectorServiceCreateResponse) GetConnectorView ¶ added in v1.7.0 

func (o *ConnectorServiceCreateResponse) GetConnectorView() *ConnectorView

func (*ConnectorServiceCreateResponse) GetExpanded ¶ added in v1.7.0 

func (o *ConnectorServiceCreateResponse) GetExpanded() []ConnectorServiceCreateResponseExpanded

type ConnectorServiceCreateResponseExpanded ¶ added in v1.10.1 

type ConnectorServiceCreateResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

ConnectorServiceCreateResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*ConnectorServiceCreateResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *ConnectorServiceCreateResponseExpanded) GetAdditionalProperties() map[string]any

func (*ConnectorServiceCreateResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *ConnectorServiceCreateResponseExpanded) GetAtType() *string

func (ConnectorServiceCreateResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (c ConnectorServiceCreateResponseExpanded) MarshalJSON() ([]byte, error)

func (*ConnectorServiceCreateResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (c *ConnectorServiceCreateResponseExpanded) UnmarshalJSON(data []byte) error

type ConnectorServiceDeleteRequest ¶ added in v1.7.0 

type ConnectorServiceDeleteRequest struct {
}

ConnectorServiceDeleteRequest is a request for deleting a connector. It uses URL values for input.

type ConnectorServiceDeleteResponse ¶ added in v1.7.0 

type ConnectorServiceDeleteResponse struct {
}

ConnectorServiceDeleteResponse - Empty response body. Status code indicates success.

type ConnectorServiceGetCredentialsResponse ¶ added in v1.7.0 

type ConnectorServiceGetCredentialsResponse struct {
	// ConnectorCredential is used by a connector to authenticate with conductor one.
	ConnectorCredential *ConnectorCredential `json:"credential,omitempty"`
}

ConnectorServiceGetCredentialsResponse is the response returned by the get method.

func (*ConnectorServiceGetCredentialsResponse) GetConnectorCredential ¶ added in v1.7.0 

func (o *ConnectorServiceGetCredentialsResponse) GetConnectorCredential() *ConnectorCredential

type ConnectorServiceGetResponse ¶ added in v1.7.0 

type ConnectorServiceGetResponse struct {
	// The ConnectorView object provides a connector response object, as well as JSONPATHs to related objects provided by expanders.
	ConnectorView *ConnectorView `json:"connectorView,omitempty"`
	// The array of expanded items indicated by the request.
	Expanded []ConnectorServiceGetResponseExpanded `json:"expanded,omitempty"`
}

The ConnectorServiceGetResponse message contains the connectorView, and an expand mask.

func (*ConnectorServiceGetResponse) GetConnectorView ¶ added in v1.7.0 

func (o *ConnectorServiceGetResponse) GetConnectorView() *ConnectorView

func (*ConnectorServiceGetResponse) GetExpanded ¶ added in v1.7.0 

func (o *ConnectorServiceGetResponse) GetExpanded() []ConnectorServiceGetResponseExpanded

type ConnectorServiceGetResponseExpanded ¶ added in v1.10.1 

type ConnectorServiceGetResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

ConnectorServiceGetResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*ConnectorServiceGetResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *ConnectorServiceGetResponseExpanded) GetAdditionalProperties() map[string]any

func (*ConnectorServiceGetResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *ConnectorServiceGetResponseExpanded) GetAtType() *string

func (ConnectorServiceGetResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (c ConnectorServiceGetResponseExpanded) MarshalJSON() ([]byte, error)

func (*ConnectorServiceGetResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (c *ConnectorServiceGetResponseExpanded) UnmarshalJSON(data []byte) error

type ConnectorServiceListResponse ¶ added in v1.7.0 

type ConnectorServiceListResponse struct {
	// List of serialized related objects
	Expanded []ConnectorServiceListResponseExpanded `json:"expanded,omitempty"`
	// The list of results containing up to X results, where X is the page size defined in the request
	List []ConnectorView `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The ConnectorServiceListResponse message contains a list of results and a nextPageToken if applicable

func (*ConnectorServiceListResponse) GetExpanded ¶ added in v1.7.0 

func (o *ConnectorServiceListResponse) GetExpanded() []ConnectorServiceListResponseExpanded

func (*ConnectorServiceListResponse) GetList ¶ added in v1.7.0 

func (o *ConnectorServiceListResponse) GetList() []ConnectorView

func (*ConnectorServiceListResponse) GetNextPageToken ¶ added in v1.7.0 

func (o *ConnectorServiceListResponse) GetNextPageToken() *string

type ConnectorServiceListResponseExpanded ¶ added in v1.10.1 

type ConnectorServiceListResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

ConnectorServiceListResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*ConnectorServiceListResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *ConnectorServiceListResponseExpanded) GetAdditionalProperties() map[string]any

func (*ConnectorServiceListResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *ConnectorServiceListResponseExpanded) GetAtType() *string

func (ConnectorServiceListResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (c ConnectorServiceListResponseExpanded) MarshalJSON() ([]byte, error)

func (*ConnectorServiceListResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (c *ConnectorServiceListResponseExpanded) UnmarshalJSON(data []byte) error

type ConnectorServiceRevokeCredentialRequest ¶ added in v1.7.0 

type ConnectorServiceRevokeCredentialRequest struct {
}

ConnectorServiceRevokeCredentialRequest is a request for revoking connector credentials. It uses URL values for input.

type ConnectorServiceRevokeCredentialResponse ¶ added in v1.7.0 

type ConnectorServiceRevokeCredentialResponse struct {
}

ConnectorServiceRevokeCredentialResponse - Empty response body. Status code indicates success.

type ConnectorServiceRotateCredentialRequest ¶ added in v1.7.0 

type ConnectorServiceRotateCredentialRequest struct {
}

ConnectorServiceRotateCredentialRequest is a request for rotating connector credentials. It uses URL values for input.

type ConnectorServiceRotateCredentialResponse ¶ added in v1.7.0 

type ConnectorServiceRotateCredentialResponse struct {
	// ConnectorCredential is used by a connector to authenticate with conductor one.
	ConnectorCredential *ConnectorCredential `json:"credential,omitempty"`
	// The new clientSecret returned after rotating the connector credential.
	ClientSecret *string `json:"clientSecret,omitempty"`
}

ConnectorServiceRotateCredentialResponse is the response returned by the rotate method.

func (*ConnectorServiceRotateCredentialResponse) GetClientSecret ¶ added in v1.7.0 

func (o *ConnectorServiceRotateCredentialResponse) GetClientSecret() *string

func (*ConnectorServiceRotateCredentialResponse) GetConnectorCredential ¶ added in v1.7.0 

func (o *ConnectorServiceRotateCredentialResponse) GetConnectorCredential() *ConnectorCredential

type ConnectorServiceUpdateDelegatedRequest ¶ added in v1.15.0 

type ConnectorServiceUpdateDelegatedRequest struct {
	// A Connector is used to sync objects into Apps
	Connector *ConnectorInput `json:"connector,omitempty"`
	// The ConnectorExpandMask is used to expand related objects on a connector.
	ConnectorExpandMask *ConnectorExpandMask `json:"expandMask,omitempty"`
	UpdateMask          *string              `json:"updateMask,omitempty"`
}

The ConnectorServiceUpdateDelegatedRequest message contains the fields required to update a connector.

func (*ConnectorServiceUpdateDelegatedRequest) GetConnector ¶ added in v1.15.0 

func (o *ConnectorServiceUpdateDelegatedRequest) GetConnector() *ConnectorInput

func (*ConnectorServiceUpdateDelegatedRequest) GetConnectorExpandMask ¶ added in v1.15.0 

func (o *ConnectorServiceUpdateDelegatedRequest) GetConnectorExpandMask() *ConnectorExpandMask

func (*ConnectorServiceUpdateDelegatedRequest) GetUpdateMask ¶ added in v1.15.0 

func (o *ConnectorServiceUpdateDelegatedRequest) GetUpdateMask() *string

type ConnectorServiceUpdateRequest ¶ added in v1.15.0 

type ConnectorServiceUpdateRequest struct {
	// A Connector is used to sync objects into Apps
	Connector *ConnectorInput `json:"connector,omitempty"`
	// The ConnectorExpandMask is used to expand related objects on a connector.
	ConnectorExpandMask *ConnectorExpandMask `json:"expandMask,omitempty"`
	UpdateMask          *string              `json:"updateMask,omitempty"`
}

The ConnectorServiceUpdateRequest message contains the fields required to update a connector.

func (*ConnectorServiceUpdateRequest) GetConnector ¶ added in v1.15.0 

func (o *ConnectorServiceUpdateRequest) GetConnector() *ConnectorInput

func (*ConnectorServiceUpdateRequest) GetConnectorExpandMask ¶ added in v1.15.0 

func (o *ConnectorServiceUpdateRequest) GetConnectorExpandMask() *ConnectorExpandMask

func (*ConnectorServiceUpdateRequest) GetUpdateMask ¶ added in v1.15.0 

func (o *ConnectorServiceUpdateRequest) GetUpdateMask() *string

type ConnectorServiceUpdateResponse ¶ added in v1.7.0 

type ConnectorServiceUpdateResponse struct {
	// The ConnectorView object provides a connector response object, as well as JSONPATHs to related objects provided by expanders.
	ConnectorView *ConnectorView `json:"connectorView,omitempty"`
	// The array of expanded items indicated by the request.
	Expanded []ConnectorServiceUpdateResponseExpanded `json:"expanded,omitempty"`
}

ConnectorServiceUpdateResponse is the response returned by the update method.

func (*ConnectorServiceUpdateResponse) GetConnectorView ¶ added in v1.7.0 

func (o *ConnectorServiceUpdateResponse) GetConnectorView() *ConnectorView

func (*ConnectorServiceUpdateResponse) GetExpanded ¶ added in v1.7.0 

func (o *ConnectorServiceUpdateResponse) GetExpanded() []ConnectorServiceUpdateResponseExpanded

type ConnectorServiceUpdateResponseExpanded ¶ added in v1.10.1 

type ConnectorServiceUpdateResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

ConnectorServiceUpdateResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*ConnectorServiceUpdateResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *ConnectorServiceUpdateResponseExpanded) GetAdditionalProperties() map[string]any

func (*ConnectorServiceUpdateResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *ConnectorServiceUpdateResponseExpanded) GetAtType() *string

func (ConnectorServiceUpdateResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (c ConnectorServiceUpdateResponseExpanded) MarshalJSON() ([]byte, error)

func (*ConnectorServiceUpdateResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (c *ConnectorServiceUpdateResponseExpanded) UnmarshalJSON(data []byte) error

type ConnectorStatus ¶ added in v1.7.0 

type ConnectorStatus struct {
	CompletedAt *time.Time `json:"completedAt,omitempty"`
	// The last error encountered by the connector.
	LastError *string    `json:"lastError,omitempty"`
	StartedAt *time.Time `json:"startedAt,omitempty"`
	// The status of the connector sync.
	Status    *ConnectorStatusStatus `json:"status,omitempty"`
	UpdatedAt *time.Time             `json:"updatedAt,omitempty"`
}

ConnectorStatus - The status field on the connector is used to track the status of the connectors sync, and when syncing last started, completed, or caused the connector to update.

func (*ConnectorStatus) GetCompletedAt ¶ added in v1.7.0 

func (o *ConnectorStatus) GetCompletedAt() *time.Time

func (*ConnectorStatus) GetLastError ¶ added in v1.7.0 

func (o *ConnectorStatus) GetLastError() *string

func (*ConnectorStatus) GetStartedAt ¶ added in v1.7.0 

func (o *ConnectorStatus) GetStartedAt() *time.Time

func (*ConnectorStatus) GetStatus ¶ added in v1.7.0 

func (o *ConnectorStatus) GetStatus() *ConnectorStatusStatus

func (*ConnectorStatus) GetUpdatedAt ¶ added in v1.7.0 

func (o *ConnectorStatus) GetUpdatedAt() *time.Time

func (ConnectorStatus) MarshalJSON ¶ added in v1.10.1 

func (c ConnectorStatus) MarshalJSON() ([]byte, error)

func (*ConnectorStatus) UnmarshalJSON ¶ added in v1.10.1 

func (c *ConnectorStatus) UnmarshalJSON(data []byte) error

type ConnectorStatusStatus ¶ added in v1.7.0 

type ConnectorStatusStatus string

ConnectorStatusStatus - The status of the connector sync. 

const (
	ConnectorStatusStatusSyncStatusUnspecified ConnectorStatusStatus = "SYNC_STATUS_UNSPECIFIED"
	ConnectorStatusStatusSyncStatusRunning     ConnectorStatusStatus = "SYNC_STATUS_RUNNING"
	ConnectorStatusStatusSyncStatusDone        ConnectorStatusStatus = "SYNC_STATUS_DONE"
	ConnectorStatusStatusSyncStatusError       ConnectorStatusStatus = "SYNC_STATUS_ERROR"
	ConnectorStatusStatusSyncStatusDisabled    ConnectorStatusStatus = "SYNC_STATUS_DISABLED"
)

func (ConnectorStatusStatus) ToPointer ¶ added in v1.7.0 

func (e ConnectorStatusStatus) ToPointer() *ConnectorStatusStatus

type ConnectorView ¶ added in v1.7.0 

type ConnectorView struct {
	// A Connector is used to sync objects into Apps
	Connector *Connector `json:"connector,omitempty"`
	// JSONPATH expression indicating the location of the App object in the expanded array.
	AppPath *string `json:"appPath,omitempty"`
	// JSONPATH expression indicating the location of the User object in the expanded array. This is the user that is a direct target of the ticket without a specific relationship to a potentially non-existent app user.
	UsersPath *string `json:"usersPath,omitempty"`
}

The ConnectorView object provides a connector response object, as well as JSONPATHs to related objects provided by expanders.

func (*ConnectorView) GetAppPath ¶ added in v1.7.0 

func (o *ConnectorView) GetAppPath() *string

func (*ConnectorView) GetConnector ¶ added in v1.7.0 

func (o *ConnectorView) GetConnector() *Connector

func (*ConnectorView) GetUsersPath ¶ added in v1.7.0 

func (o *ConnectorView) GetUsersPath() *string

type CreateAppEntitlementProxyRequest ¶ added in v1.21.3 

type CreateAppEntitlementProxyRequest struct {
	// The AppEntitlementProxyExpandMask message.
	AppEntitlementProxyExpandMask *AppEntitlementProxyExpandMask `json:"expandMask,omitempty"`
}

The CreateAppEntitlementProxyRequest message.

func (*CreateAppEntitlementProxyRequest) GetAppEntitlementProxyExpandMask ¶ added in v1.21.3 

func (o *CreateAppEntitlementProxyRequest) GetAppEntitlementProxyExpandMask() *AppEntitlementProxyExpandMask

type CreateAppEntitlementProxyResponse ¶ added in v1.21.3 

type CreateAppEntitlementProxyResponse struct {
	// The AppEntitlementProxyView message.
	AppEntitlementProxyView *AppEntitlementProxyView `json:"appProxyEntitlementView,omitempty"`
	// The expanded field.
	Expanded []CreateAppEntitlementProxyResponseExpanded `json:"expanded,omitempty"`
}

The CreateAppEntitlementProxyResponse message.

func (*CreateAppEntitlementProxyResponse) GetAppEntitlementProxyView ¶ added in v1.21.3 

func (o *CreateAppEntitlementProxyResponse) GetAppEntitlementProxyView() *AppEntitlementProxyView

func (*CreateAppEntitlementProxyResponse) GetExpanded ¶ added in v1.21.3 

func (o *CreateAppEntitlementProxyResponse) GetExpanded() []CreateAppEntitlementProxyResponseExpanded

type CreateAppEntitlementProxyResponseExpanded ¶ added in v1.21.3 

type CreateAppEntitlementProxyResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

CreateAppEntitlementProxyResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*CreateAppEntitlementProxyResponseExpanded) GetAdditionalProperties ¶ added in v1.21.3 

func (o *CreateAppEntitlementProxyResponseExpanded) GetAdditionalProperties() map[string]any

func (*CreateAppEntitlementProxyResponseExpanded) GetAtType ¶ added in v1.21.3 

func (o *CreateAppEntitlementProxyResponseExpanded) GetAtType() *string

func (CreateAppEntitlementProxyResponseExpanded) MarshalJSON ¶ added in v1.21.3 

func (c CreateAppEntitlementProxyResponseExpanded) MarshalJSON() ([]byte, error)

func (*CreateAppEntitlementProxyResponseExpanded) UnmarshalJSON ¶ added in v1.21.3 

func (c *CreateAppEntitlementProxyResponseExpanded) UnmarshalJSON(data []byte) error

type CreateAppEntitlementRequest ¶ added in v1.20.0 

type CreateAppEntitlementRequest struct {
	// The app entitlement expand mask allows the user to get additional information when getting responses containing app entitlement views.
	AppEntitlementExpandMask *AppEntitlementExpandMask `json:"expandMask,omitempty"`
	// ProvisionPolicy is a oneOf that indicates how a provision step should be processed.
	//
	// This message contains a oneof named typ. Only a single field of the following list may be set at a time:
	//   - connector
	//   - manual
	//   - delegated
	//   - webhook
	//   - multiStep
	//   - externalTicket
	//
	ProvisionPolicy *ProvisionPolicyInput `json:"provisionPolicy,omitempty"`
	// The alias field.
	Alias *string `json:"alias,omitempty"`
	// The appEntitlementOwnerIds field.
	AppEntitlementOwnerIds []string `json:"appEntitlementOwnerIds,omitempty"`
	// The appResourceId field.
	AppResourceID *string `json:"appResourceId,omitempty"`
	// The appResourceTypeId field.
	AppResourceTypeID *string `json:"appResourceTypeId,omitempty"`
	// The certifyPolicyId field.
	CertifyPolicyID *string `json:"certifyPolicyId,omitempty"`
	// The complianceFrameworkValueIds field.
	ComplianceFrameworkValueIds []string `json:"complianceFrameworkValueIds,omitempty"`
	// The description field.
	Description *string `json:"description,omitempty"`
	// The displayName field.
	DisplayName   *string                                   `json:"displayName,omitempty"`
	DurationGrant *string                                   `json:"durationGrant,omitempty"`
	DurationUnset *CreateAppEntitlementRequestDurationUnset `json:"durationUnset,omitempty"`
	// The emergencyGrantEnabled field.
	EmergencyGrantEnabled *bool `json:"emergencyGrantEnabled,omitempty"`
	// The emergencyGrantPolicyId field.
	EmergencyGrantPolicyID *string `json:"emergencyGrantPolicyId,omitempty"`
	// The grantPolicyId field.
	GrantPolicyID *string `json:"grantPolicyId,omitempty"`
	// The overrideAccessRequestsDefaults field.
	OverrideAccessRequestsDefaults *bool `json:"overrideAccessRequestsDefaults,omitempty"`
	// The purpose field.
	Purpose *CreateAppEntitlementRequestPurpose `json:"purpose,omitempty"`
	// The revokePolicyId field.
	RevokePolicyID *string `json:"revokePolicyId,omitempty"`
	// The riskLevelValueId field.
	RiskLevelValueID *string `json:"riskLevelValueId,omitempty"`
	// The slug field.
	Slug *string `json:"slug,omitempty"`
}

The CreateAppEntitlementRequest message.

This message contains a oneof named max_grant_duration. Only a single field of the following list may be set at a time:

  • durationUnset
  • durationGrant

func (*CreateAppEntitlementRequest) GetAlias ¶ added in v1.21.4 

func (o *CreateAppEntitlementRequest) GetAlias() *string

func (*CreateAppEntitlementRequest) GetAppEntitlementExpandMask ¶ added in v1.20.0 

func (o *CreateAppEntitlementRequest) GetAppEntitlementExpandMask() *AppEntitlementExpandMask

func (*CreateAppEntitlementRequest) GetAppEntitlementOwnerIds ¶ added in v1.20.0 

func (o *CreateAppEntitlementRequest) GetAppEntitlementOwnerIds() []string

func (*CreateAppEntitlementRequest) GetAppResourceID ¶ added in v1.20.0 

func (o *CreateAppEntitlementRequest) GetAppResourceID() *string

func (*CreateAppEntitlementRequest) GetAppResourceTypeID ¶ added in v1.20.0 

func (o *CreateAppEntitlementRequest) GetAppResourceTypeID() *string

func (*CreateAppEntitlementRequest) GetCertifyPolicyID ¶ added in v1.21.4 

func (o *CreateAppEntitlementRequest) GetCertifyPolicyID() *string

func (*CreateAppEntitlementRequest) GetComplianceFrameworkValueIds ¶ added in v1.21.4 

func (o *CreateAppEntitlementRequest) GetComplianceFrameworkValueIds() []string

func (*CreateAppEntitlementRequest) GetDescription ¶ added in v1.20.0 

func (o *CreateAppEntitlementRequest) GetDescription() *string

func (*CreateAppEntitlementRequest) GetDisplayName ¶ added in v1.20.0 

func (o *CreateAppEntitlementRequest) GetDisplayName() *string

func (*CreateAppEntitlementRequest) GetDurationGrant ¶ added in v1.21.4 

func (o *CreateAppEntitlementRequest) GetDurationGrant() *string

func (*CreateAppEntitlementRequest) GetDurationUnset ¶ added in v1.21.4 

func (o *CreateAppEntitlementRequest) GetDurationUnset() *CreateAppEntitlementRequestDurationUnset

func (*CreateAppEntitlementRequest) GetEmergencyGrantEnabled ¶ added in v1.21.4 

func (o *CreateAppEntitlementRequest) GetEmergencyGrantEnabled() *bool

func (*CreateAppEntitlementRequest) GetEmergencyGrantPolicyID ¶ added in v1.21.4 

func (o *CreateAppEntitlementRequest) GetEmergencyGrantPolicyID() *string

func (*CreateAppEntitlementRequest) GetGrantPolicyID ¶ added in v1.21.4 

func (o *CreateAppEntitlementRequest) GetGrantPolicyID() *string

func (*CreateAppEntitlementRequest) GetOverrideAccessRequestsDefaults ¶ added in v1.21.4 

func (o *CreateAppEntitlementRequest) GetOverrideAccessRequestsDefaults() *bool

func (*CreateAppEntitlementRequest) GetProvisionPolicy ¶ added in v1.21.4 

func (o *CreateAppEntitlementRequest) GetProvisionPolicy() *ProvisionPolicyInput

func (*CreateAppEntitlementRequest) GetPurpose ¶ added in v1.21.4 

func (o *CreateAppEntitlementRequest) GetPurpose() *CreateAppEntitlementRequestPurpose

func (*CreateAppEntitlementRequest) GetRevokePolicyID ¶ added in v1.21.4 

func (o *CreateAppEntitlementRequest) GetRevokePolicyID() *string

func (*CreateAppEntitlementRequest) GetRiskLevelValueID ¶ added in v1.21.4 

func (o *CreateAppEntitlementRequest) GetRiskLevelValueID() *string

func (*CreateAppEntitlementRequest) GetSlug ¶ added in v1.21.4 

func (o *CreateAppEntitlementRequest) GetSlug() *string

type CreateAppEntitlementRequestDurationUnset ¶ added in v1.21.4 

type CreateAppEntitlementRequestDurationUnset struct {
}

type CreateAppEntitlementRequestPurpose ¶ added in v1.21.4 

type CreateAppEntitlementRequestPurpose string

CreateAppEntitlementRequestPurpose - The purpose field. 

const (
	CreateAppEntitlementRequestPurposeAppEntitlementPurposeValueUnspecified CreateAppEntitlementRequestPurpose = "APP_ENTITLEMENT_PURPOSE_VALUE_UNSPECIFIED"
	CreateAppEntitlementRequestPurposeAppEntitlementPurposeValueAssignment  CreateAppEntitlementRequestPurpose = "APP_ENTITLEMENT_PURPOSE_VALUE_ASSIGNMENT"
	CreateAppEntitlementRequestPurposeAppEntitlementPurposeValuePermission  CreateAppEntitlementRequestPurpose = "APP_ENTITLEMENT_PURPOSE_VALUE_PERMISSION"
)

func (CreateAppEntitlementRequestPurpose) ToPointer ¶ added in v1.21.4 

func (e CreateAppEntitlementRequestPurpose) ToPointer() *CreateAppEntitlementRequestPurpose

type CreateAppEntitlementResponse ¶ added in v1.20.0 

type CreateAppEntitlementResponse struct {
	// The app entitlement view contains the serialized app entitlement and paths to objects referenced by the app entitlement.
	AppEntitlementView *AppEntitlementView `json:"appEntitlementView,omitempty"`
	// The expanded field.
	Expanded []CreateAppEntitlementResponseExpanded `json:"expanded,omitempty"`
}

The CreateAppEntitlementResponse message.

func (*CreateAppEntitlementResponse) GetAppEntitlementView ¶ added in v1.20.0 

func (o *CreateAppEntitlementResponse) GetAppEntitlementView() *AppEntitlementView

func (*CreateAppEntitlementResponse) GetExpanded ¶ added in v1.20.0 

func (o *CreateAppEntitlementResponse) GetExpanded() []CreateAppEntitlementResponseExpanded

type CreateAppEntitlementResponseExpanded ¶ added in v1.20.0 

type CreateAppEntitlementResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

CreateAppEntitlementResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*CreateAppEntitlementResponseExpanded) GetAdditionalProperties ¶ added in v1.20.0 

func (o *CreateAppEntitlementResponseExpanded) GetAdditionalProperties() map[string]any

func (*CreateAppEntitlementResponseExpanded) GetAtType ¶ added in v1.20.0 

func (o *CreateAppEntitlementResponseExpanded) GetAtType() *string

func (CreateAppEntitlementResponseExpanded) MarshalJSON ¶ added in v1.20.0 

func (c CreateAppEntitlementResponseExpanded) MarshalJSON() ([]byte, error)

func (*CreateAppEntitlementResponseExpanded) UnmarshalJSON ¶ added in v1.20.0 

func (c *CreateAppEntitlementResponseExpanded) UnmarshalJSON(data []byte) error

type CreateAppRequest ¶ added in v1.7.0 

type CreateAppRequest struct {
	// Creates the app with this certify policy.
	CertifyPolicyID *string `json:"certifyPolicyId,omitempty"`
	// Creates the app with this description.
	Description *string `json:"description,omitempty"`
	// Creates the app with this display name.
	DisplayName *string `json:"displayName,omitempty"`
	// Creates the app with this grant policy.
	GrantPolicyID *string `json:"grantPolicyId,omitempty"`
	// Creates the app with this monthly cost per seat.
	MonthlyCostUsd *int `json:"monthlyCostUsd,omitempty"`
	// Creates the app with this array of owners.
	Owners []string `json:"owners,omitempty"`
	// Creates the app with this revoke policy.
	RevokePolicyID *string `json:"revokePolicyId,omitempty"`
}

The CreateAppRequest message is used to create a new app.

func (*CreateAppRequest) GetCertifyPolicyID ¶ added in v1.7.0 

func (o *CreateAppRequest) GetCertifyPolicyID() *string

func (*CreateAppRequest) GetDescription ¶ added in v1.7.0 

func (o *CreateAppRequest) GetDescription() *string

func (*CreateAppRequest) GetDisplayName ¶ added in v1.7.0 

func (o *CreateAppRequest) GetDisplayName() *string

func (*CreateAppRequest) GetGrantPolicyID ¶ added in v1.7.0 

func (o *CreateAppRequest) GetGrantPolicyID() *string

func (*CreateAppRequest) GetMonthlyCostUsd ¶ added in v1.7.0 

func (o *CreateAppRequest) GetMonthlyCostUsd() *int

func (*CreateAppRequest) GetOwners ¶ added in v1.7.0 

func (o *CreateAppRequest) GetOwners() []string

func (*CreateAppRequest) GetRevokePolicyID ¶ added in v1.7.0 

func (o *CreateAppRequest) GetRevokePolicyID() *string

type CreateAppResponse ¶ added in v1.7.0 

type CreateAppResponse struct {
	// The App object provides all of the details for an app, as well as some configuration.
	App *App `json:"app,omitempty"`
}

CreateAppResponse - Returns the new app's values.

func (*CreateAppResponse) GetApp ¶ added in v1.7.0 

func (o *CreateAppResponse) GetApp() *App

type CreateAttributeValueRequest ¶ added in v1.8.0 

type CreateAttributeValueRequest struct {
	// The attributeTypeId field.
	AttributeTypeID *string `json:"attributeTypeId,omitempty"`
	// The value field.
	Value *string `json:"value,omitempty"`
}

The CreateAttributeValueRequest message.

func (*CreateAttributeValueRequest) GetAttributeTypeID ¶ added in v1.8.0 

func (o *CreateAttributeValueRequest) GetAttributeTypeID() *string

func (*CreateAttributeValueRequest) GetValue ¶ added in v1.8.0 

func (o *CreateAttributeValueRequest) GetValue() *string

type CreateAttributeValueResponse ¶ added in v1.8.0 

type CreateAttributeValueResponse struct {
	// AttributeValue is the value of an attribute of a defined type.
	AttributeValue *AttributeValue `json:"value,omitempty"`
}

CreateAttributeValueResponse is the response for creating an attribute value.

func (*CreateAttributeValueResponse) GetAttributeValue ¶ added in v1.8.0 

func (o *CreateAttributeValueResponse) GetAttributeValue() *AttributeValue

type CreateManuallyManagedAppResourceRequest ¶ added in v1.20.0 

type CreateManuallyManagedAppResourceRequest struct {
	// The description field.
	Description *string `json:"description,omitempty"`
	// The displayName field.
	DisplayName *string `json:"displayName,omitempty"`
	// The resourceOwnerUserIds field.
	ResourceOwnerUserIds []string `json:"resourceOwnerUserIds,omitempty"`
}

The CreateManuallyManagedAppResourceRequest message.

func (*CreateManuallyManagedAppResourceRequest) GetDescription ¶ added in v1.20.0 

func (o *CreateManuallyManagedAppResourceRequest) GetDescription() *string

func (*CreateManuallyManagedAppResourceRequest) GetDisplayName ¶ added in v1.20.0 

func (o *CreateManuallyManagedAppResourceRequest) GetDisplayName() *string

func (*CreateManuallyManagedAppResourceRequest) GetResourceOwnerUserIds ¶ added in v1.20.0 

func (o *CreateManuallyManagedAppResourceRequest) GetResourceOwnerUserIds() []string

type CreateManuallyManagedAppResourceResponse ¶ added in v1.20.0 

type CreateManuallyManagedAppResourceResponse struct {
	// The app resource message is a single resource that can have entitlements.
	AppResource *AppResource `json:"appResource,omitempty"`
}

The CreateManuallyManagedAppResourceResponse message.

func (*CreateManuallyManagedAppResourceResponse) GetAppResource ¶ added in v1.20.0 

func (o *CreateManuallyManagedAppResourceResponse) GetAppResource() *AppResource

type CreateManuallyManagedResourceTypeRequest ¶ added in v1.20.0 

type CreateManuallyManagedResourceTypeRequest struct {
	// The name field.
	Name *string `json:"name,omitempty"`
	// The resourceType field.
	ResourceType *ResourceType `json:"resourceType,omitempty"`
}

The CreateManuallyManagedResourceTypeRequest message.

func (*CreateManuallyManagedResourceTypeRequest) GetName ¶ added in v1.20.0 

func (o *CreateManuallyManagedResourceTypeRequest) GetName() *string

func (*CreateManuallyManagedResourceTypeRequest) GetResourceType ¶ added in v1.20.0 

func (o *CreateManuallyManagedResourceTypeRequest) GetResourceType() *ResourceType

type CreateManuallyManagedResourceTypeResponse ¶ added in v1.20.0 

type CreateManuallyManagedResourceTypeResponse struct {
	// The AppResourceType is referenced by an app entitlement defining its resource types. Commonly things like Group or Role.
	AppResourceType *AppResourceType `json:"appResourceType,omitempty"`
	// The expanded field.
	Expanded []CreateManuallyManagedResourceTypeResponseExpanded `json:"expanded,omitempty"`
}

The CreateManuallyManagedResourceTypeResponse message.

func (*CreateManuallyManagedResourceTypeResponse) GetAppResourceType ¶ added in v1.20.0 

func (o *CreateManuallyManagedResourceTypeResponse) GetAppResourceType() *AppResourceType

func (*CreateManuallyManagedResourceTypeResponse) GetExpanded ¶ added in v1.20.0 

func (o *CreateManuallyManagedResourceTypeResponse) GetExpanded() []CreateManuallyManagedResourceTypeResponseExpanded

type CreateManuallyManagedResourceTypeResponseExpanded ¶ added in v1.20.0 

type CreateManuallyManagedResourceTypeResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

CreateManuallyManagedResourceTypeResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*CreateManuallyManagedResourceTypeResponseExpanded) GetAdditionalProperties ¶ added in v1.20.0 

func (o *CreateManuallyManagedResourceTypeResponseExpanded) GetAdditionalProperties() map[string]any

func (*CreateManuallyManagedResourceTypeResponseExpanded) GetAtType ¶ added in v1.20.0 

func (o *CreateManuallyManagedResourceTypeResponseExpanded) GetAtType() *string

func (CreateManuallyManagedResourceTypeResponseExpanded) MarshalJSON ¶ added in v1.20.0 

func (c CreateManuallyManagedResourceTypeResponseExpanded) MarshalJSON() ([]byte, error)

func (*CreateManuallyManagedResourceTypeResponseExpanded) UnmarshalJSON ¶ added in v1.20.0 

func (c *CreateManuallyManagedResourceTypeResponseExpanded) UnmarshalJSON(data []byte) error

type CreatePolicyRequest ¶ added in v1.0.3 

type CreatePolicyRequest struct {
	// The description of the new policy.
	Description *string `json:"description,omitempty"`
	// The display name of the new policy.
	DisplayName *string `json:"displayName,omitempty"`
	// The map of policy type to policy steps. The key is the stringified version of the enum. See other policies for examples.
	PolicySteps map[string]PolicyStepsInput `json:"policySteps,omitempty"`
	// The enum of the policy type.
	PolicyType *PolicyType `json:"policyType,omitempty"`
	// Actions to occur after a policy finishes. As of now this is only valid on a certify policy to remediate a denied certification immediately.
	PostActions []PolicyPostActions `json:"postActions,omitempty"`
	// Allows reassigning tasks to delegates.
	ReassignTasksToDelegates *bool `json:"reassignTasksToDelegates,omitempty"`
	// The rules field.
	Rules []Rule `json:"rules,omitempty"`
}

The CreatePolicyRequest message is used to create a new policy.

func (*CreatePolicyRequest) GetDescription ¶ added in v1.6.1 

func (o *CreatePolicyRequest) GetDescription() *string

func (*CreatePolicyRequest) GetDisplayName ¶ added in v1.6.1 

func (o *CreatePolicyRequest) GetDisplayName() *string

func (*CreatePolicyRequest) GetPolicySteps ¶ added in v1.6.1 

func (o *CreatePolicyRequest) GetPolicySteps() map[string]PolicyStepsInput

func (*CreatePolicyRequest) GetPolicyType ¶ added in v1.6.1 

func (o *CreatePolicyRequest) GetPolicyType() *PolicyType

func (*CreatePolicyRequest) GetPostActions ¶ added in v1.6.1 

func (o *CreatePolicyRequest) GetPostActions() []PolicyPostActions

func (*CreatePolicyRequest) GetReassignTasksToDelegates ¶ added in v1.6.1 

func (o *CreatePolicyRequest) GetReassignTasksToDelegates() *bool

func (*CreatePolicyRequest) GetRules ¶ added in v1.18.3 

func (o *CreatePolicyRequest) GetRules() []Rule

type CreatePolicyResponse ¶ added in v1.1.1 

type CreatePolicyResponse struct {
	// A policy describes the behavior of the ConductorOne system when processing a task. You can describe the type, approvers, fallback behavior, and escalation processes.
	Policy *Policy `json:"policy,omitempty"`
}

The CreatePolicyResponse message contains the created policy object.

func (*CreatePolicyResponse) GetPolicy ¶ added in v1.6.1 

func (o *CreatePolicyResponse) GetPolicy() *Policy

type CurrentStep ¶ added in v1.15.0 

type CurrentStep string

CurrentStep - Search tasks that have this type of step as the current step. 

const (
	CurrentStepTaskSearchCurrentStepUnspecified CurrentStep = "TASK_SEARCH_CURRENT_STEP_UNSPECIFIED"
	CurrentStepTaskSearchCurrentStepApproval    CurrentStep = "TASK_SEARCH_CURRENT_STEP_APPROVAL"
	CurrentStepTaskSearchCurrentStepProvision   CurrentStep = "TASK_SEARCH_CURRENT_STEP_PROVISION"
)

func (CurrentStep) ToPointer ¶ added in v1.15.0 

func (e CurrentStep) ToPointer() *CurrentStep

type DelegatedProvision ¶ added in v1.0.3 

type DelegatedProvision struct {
	// The AppID of the entitlement to delegate provisioning to.
	AppID *string `json:"appId,omitempty"`
	// The ID of the entitlement we are delegating provisioning to.
	EntitlementID *string `json:"entitlementId,omitempty"`
	// If true, a binding will be automatically created from the entitlement of the parent app.
	Implicit *bool `json:"implicit,omitempty"`
}

DelegatedProvision - This provision step indicates that we should delegate provisioning to the configuration of another app entitlement. This app entitlement does not have to be one from the same app, but MUST be configured as a proxy binding leading into this entitlement.

func (*DelegatedProvision) GetAppID ¶ added in v1.6.1 

func (o *DelegatedProvision) GetAppID() *string

func (*DelegatedProvision) GetEntitlementID ¶ added in v1.6.1 

func (o *DelegatedProvision) GetEntitlementID() *string

func (*DelegatedProvision) GetImplicit ¶ added in v1.15.0 

func (o *DelegatedProvision) GetImplicit() *bool

type DeleteAppEntitlementProxyRequest ¶ added in v1.21.3 

type DeleteAppEntitlementProxyRequest struct {
}

The DeleteAppEntitlementProxyRequest message.

type DeleteAppEntitlementProxyResponse ¶ added in v1.21.3 

type DeleteAppEntitlementProxyResponse struct {
}

The DeleteAppEntitlementProxyResponse message.

type DeleteAppEntitlementRequest ¶ added in v1.20.0 

type DeleteAppEntitlementRequest struct {
}

The DeleteAppEntitlementRequest message.

type DeleteAppEntitlementResponse ¶ added in v1.20.0 

type DeleteAppEntitlementResponse struct {
}

The DeleteAppEntitlementResponse message.

type DeleteAppRequest ¶ added in v1.7.0 

type DeleteAppRequest struct {
}

DeleteAppRequest - Empty request body

type DeleteAppResponse ¶ added in v1.7.0 

type DeleteAppResponse struct {
}

DeleteAppResponse - Empty response body. Status code indicates success.

type DeleteAttributeValueRequest ¶ added in v1.8.0 

type DeleteAttributeValueRequest struct {
}

The DeleteAttributeValueRequest message.

type DeleteAttributeValueResponse ¶ added in v1.8.0 

type DeleteAttributeValueResponse struct {
}

DeleteAttributeValueResponse is the empty response for deleting an attribute value.

type DeleteManuallyManagedAppResourceRequest ¶ added in v1.20.0 

type DeleteManuallyManagedAppResourceRequest struct {
}

The DeleteManuallyManagedAppResourceRequest message.

type DeleteManuallyManagedAppResourceResponse ¶ added in v1.20.0 

type DeleteManuallyManagedAppResourceResponse struct {
}

The DeleteManuallyManagedAppResourceResponse message.

type DeleteManuallyManagedResourceTypeRequest ¶ added in v1.20.0 

type DeleteManuallyManagedResourceTypeRequest struct {
}

The DeleteManuallyManagedResourceTypeRequest message.

type DeleteManuallyManagedResourceTypeResponse ¶ added in v1.20.0 

type DeleteManuallyManagedResourceTypeResponse struct {
}

The DeleteManuallyManagedResourceTypeResponse message.

type DeletePolicyRequest ¶ added in v1.0.3 

type DeletePolicyRequest struct {
}

The DeletePolicyRequest message contains the ID of the policy to delete. It uses URL value for input.

type DeletePolicyResponse ¶ added in v1.0.3 

type DeletePolicyResponse struct {
}

DeletePolicyResponse - Empty response with a status code indicating success.

type DeniedAction ¶ added in v1.0.3 

type DeniedAction struct {
	DeniedAt *time.Time `json:"deniedAt,omitempty"`
	// The UserID that denied this step.
	UserID *string `json:"userId,omitempty"`
}

DeniedAction - The denied action indicates that the c1.api.policy.v1.ApprovalInstance had an outcome of denied.

func (*DeniedAction) GetDeniedAt ¶ added in v1.6.1 

func (o *DeniedAction) GetDeniedAt() *time.Time

func (*DeniedAction) GetUserID ¶ added in v1.6.1 

func (o *DeniedAction) GetUserID() *string

func (DeniedAction) MarshalJSON ¶ added in v1.10.1 

func (d DeniedAction) MarshalJSON() ([]byte, error)

func (*DeniedAction) UnmarshalJSON ¶ added in v1.10.1 

func (d *DeniedAction) UnmarshalJSON(data []byte) error

type Details ¶ added in v1.21.4 

type Details struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

Details - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*Details) GetAdditionalProperties ¶ added in v1.21.4 

func (o *Details) GetAdditionalProperties() map[string]any

func (*Details) GetAtType ¶ added in v1.21.4 

func (o *Details) GetAtType() *string

func (Details) MarshalJSON ¶ added in v1.21.4 

func (d Details) MarshalJSON() ([]byte, error)

func (*Details) UnmarshalJSON ¶ added in v1.21.4 

func (d *Details) UnmarshalJSON(data []byte) error

type Directory ¶ added in v1.0.3 

type Directory struct {
	// The ID of the app associated with the directory.
	AppID     *string    `json:"appId,omitempty"`
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
}

Directory - This object indicates that an app is also a directory.

func (*Directory) GetAppID ¶ added in v1.6.1 

func (o *Directory) GetAppID() *string

func (*Directory) GetCreatedAt ¶ added in v1.6.1 

func (o *Directory) GetCreatedAt() *time.Time

func (*Directory) GetDeletedAt ¶ added in v1.6.1 

func (o *Directory) GetDeletedAt() *time.Time

func (*Directory) GetUpdatedAt ¶ added in v1.6.1 

func (o *Directory) GetUpdatedAt() *time.Time

func (Directory) MarshalJSON ¶ added in v1.10.1 

func (d Directory) MarshalJSON() ([]byte, error)

func (*Directory) UnmarshalJSON ¶ added in v1.10.1 

func (d *Directory) UnmarshalJSON(data []byte) error

type DirectoryExpandMask ¶ added in v1.0.3 

type DirectoryExpandMask struct {
	// An array of fields to be included in the directory response.
	Paths []string `json:"paths,omitempty"`
}

DirectoryExpandMask - The fields to be included in the directory response.

func (*DirectoryExpandMask) GetPaths ¶ added in v1.6.1 

func (o *DirectoryExpandMask) GetPaths() []string

type DirectoryServiceCreateRequest ¶ added in v1.0.3 

type DirectoryServiceCreateRequest struct {
	// The fields to be included in the directory response.
	DirectoryExpandMask *DirectoryExpandMask `json:"expandMask,omitempty"`
	// The AppID to make into a directory, providing identities and more for the C1 app.
	AppID *string `json:"appId,omitempty"`
}

DirectoryServiceCreateRequest - Uplevel an app into a full directory.

func (*DirectoryServiceCreateRequest) GetAppID ¶ added in v1.6.1 

func (o *DirectoryServiceCreateRequest) GetAppID() *string

func (*DirectoryServiceCreateRequest) GetDirectoryExpandMask ¶ added in v1.6.1 

func (o *DirectoryServiceCreateRequest) GetDirectoryExpandMask() *DirectoryExpandMask

type DirectoryServiceCreateResponse ¶ added in v1.0.3 

type DirectoryServiceCreateResponse struct {
	// The directory view contains a directory and an app_path which is a JSONPATH set to the location in the expand mask that the expanded app will live if requested by the expander.
	DirectoryView *DirectoryView `json:"directoryView,omitempty"`
	// List of serialized related objects.
	Expanded []DirectoryServiceCreateResponseExpanded `json:"expanded,omitempty"`
}

The DirectoryServiceCreateResponse message.

func (*DirectoryServiceCreateResponse) GetDirectoryView ¶ added in v1.6.1 

func (o *DirectoryServiceCreateResponse) GetDirectoryView() *DirectoryView

func (*DirectoryServiceCreateResponse) GetExpanded ¶ added in v1.6.1 

func (o *DirectoryServiceCreateResponse) GetExpanded() []DirectoryServiceCreateResponseExpanded

type DirectoryServiceCreateResponseExpanded ¶ added in v1.10.1 

type DirectoryServiceCreateResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

DirectoryServiceCreateResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*DirectoryServiceCreateResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *DirectoryServiceCreateResponseExpanded) GetAdditionalProperties() map[string]any

func (*DirectoryServiceCreateResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *DirectoryServiceCreateResponseExpanded) GetAtType() *string

func (DirectoryServiceCreateResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (d DirectoryServiceCreateResponseExpanded) MarshalJSON() ([]byte, error)

func (*DirectoryServiceCreateResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (d *DirectoryServiceCreateResponseExpanded) UnmarshalJSON(data []byte) error

type DirectoryServiceDeleteRequest ¶ added in v1.0.3 

type DirectoryServiceDeleteRequest struct {
}

DirectoryServiceDeleteRequest is the request message for deleting a directory. It uses URL values for input.

type DirectoryServiceDeleteResponse ¶ added in v1.0.3 

type DirectoryServiceDeleteResponse struct {
}

DirectoryServiceDeleteResponse - Empty response with a status code indicating success.

type DirectoryServiceGetResponse ¶ added in v1.0.3 

type DirectoryServiceGetResponse struct {
	// The directory view contains a directory and an app_path which is a JSONPATH set to the location in the expand mask that the expanded app will live if requested by the expander.
	DirectoryView *DirectoryView `json:"directoryView,omitempty"`
	// List of serialized related objects.
	Expanded []DirectoryServiceGetResponseExpanded `json:"expanded,omitempty"`
}

DirectoryServiceGetResponse - The Directory Service Get Response returns a directory view with a directory and JSONPATHs indicating the 

location in the expanded array that items are expanded as indicated by the expand mask in the request.

func (*DirectoryServiceGetResponse) GetDirectoryView ¶ added in v1.6.1 

func (o *DirectoryServiceGetResponse) GetDirectoryView() *DirectoryView

func (*DirectoryServiceGetResponse) GetExpanded ¶ added in v1.6.1 

func (o *DirectoryServiceGetResponse) GetExpanded() []DirectoryServiceGetResponseExpanded

type DirectoryServiceGetResponseExpanded ¶ added in v1.10.1 

type DirectoryServiceGetResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

DirectoryServiceGetResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*DirectoryServiceGetResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *DirectoryServiceGetResponseExpanded) GetAdditionalProperties() map[string]any

func (*DirectoryServiceGetResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *DirectoryServiceGetResponseExpanded) GetAtType() *string

func (DirectoryServiceGetResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (d DirectoryServiceGetResponseExpanded) MarshalJSON() ([]byte, error)

func (*DirectoryServiceGetResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (d *DirectoryServiceGetResponseExpanded) UnmarshalJSON(data []byte) error

type DirectoryServiceListResponse ¶ added in v1.0.3 

type DirectoryServiceListResponse struct {
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retreived.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	Expanded []DirectoryServiceListResponseExpanded `json:"expanded,omitempty"`
	// The list of results containing up to X results, where X is the page size defined in the request.
	List []DirectoryView `json:"list,omitempty"`
	// List of serialized related objects.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The DirectoryServiceListResponse message contains a list of results and a nextPageToken if applicable.

func (*DirectoryServiceListResponse) GetExpanded ¶ added in v1.6.1 

func (o *DirectoryServiceListResponse) GetExpanded() []DirectoryServiceListResponseExpanded

func (*DirectoryServiceListResponse) GetList ¶ added in v1.6.1 

func (o *DirectoryServiceListResponse) GetList() []DirectoryView

func (*DirectoryServiceListResponse) GetNextPageToken ¶ added in v1.6.1 

func (o *DirectoryServiceListResponse) GetNextPageToken() *string

type DirectoryServiceListResponseExpanded ¶ added in v1.10.1 

type DirectoryServiceListResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

DirectoryServiceListResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*DirectoryServiceListResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *DirectoryServiceListResponseExpanded) GetAdditionalProperties() map[string]any

func (*DirectoryServiceListResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *DirectoryServiceListResponseExpanded) GetAtType() *string

func (DirectoryServiceListResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (d DirectoryServiceListResponseExpanded) MarshalJSON() ([]byte, error)

func (*DirectoryServiceListResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (d *DirectoryServiceListResponseExpanded) UnmarshalJSON(data []byte) error

type DirectoryStatus ¶ added in v1.15.0 

type DirectoryStatus string

DirectoryStatus - The status of the user in the directory. 

const (
	DirectoryStatusUnknown  DirectoryStatus = "UNKNOWN"
	DirectoryStatusEnabled  DirectoryStatus = "ENABLED"
	DirectoryStatusDisabled DirectoryStatus = "DISABLED"
	DirectoryStatusDeleted  DirectoryStatus = "DELETED"
)

func (DirectoryStatus) ToPointer ¶ added in v1.15.0 

func (e DirectoryStatus) ToPointer() *DirectoryStatus

type DirectoryView ¶ added in v1.0.3 

type DirectoryView struct {
	// This object indicates that an app is also a directory.
	Directory *Directory `json:"directory,omitempty"`
	// JSONPATH expression indicating the location of the App object in the  array.
	AppPath *string `json:"appPath,omitempty"`
}

DirectoryView - The directory view contains a directory and an app_path which is a JSONPATH set to the location in the expand mask that the expanded app will live if requested by the expander.

func (*DirectoryView) GetAppPath ¶ added in v1.6.1 

func (o *DirectoryView) GetAppPath() *string

func (*DirectoryView) GetDirectory ¶ added in v1.6.1 

func (o *DirectoryView) GetDirectory() *Directory

type DurationUnset ¶ added in v1.15.0 

type DurationUnset struct {
}

type EmergencyStatus ¶ added in v1.15.0 

type EmergencyStatus string

EmergencyStatus - Search tasks that are or are not emergency access. 

const (
	EmergencyStatusUnspecified  EmergencyStatus = "UNSPECIFIED"
	EmergencyStatusAll          EmergencyStatus = "ALL"
	EmergencyStatusNonEmergency EmergencyStatus = "NON_EMERGENCY"
	EmergencyStatusEmergency    EmergencyStatus = "EMERGENCY"
)

func (EmergencyStatus) ToPointer ¶ added in v1.15.0 

func (e EmergencyStatus) ToPointer() *EmergencyStatus

type EncryptedData ¶ added in v1.21.4 

type EncryptedData struct {
	// The human-readable description of the encrypted data.
	Description *string `json:"description,omitempty"`
	// The encrypted bytes.
	EncryptedBytes *string `json:"encryptedBytes,omitempty"`
	// The key ID used to encrypt the data.
	KeyID *string `json:"keyId,omitempty"`
	// The human-readable name of the encrypted data.
	Name *string `json:"name,omitempty"`
	// The encryption provider used to encrypt the data.
	Provider *string `json:"provider,omitempty"`
	// The (optional) JSON schema of the encrypted data.
	Schema *string `json:"schema,omitempty"`
}

EncryptedData is a message that contains encrypted bytes and metadata.

func (*EncryptedData) GetDescription ¶ added in v1.21.4 

func (o *EncryptedData) GetDescription() *string

func (*EncryptedData) GetEncryptedBytes ¶ added in v1.21.4 

func (o *EncryptedData) GetEncryptedBytes() *string

func (*EncryptedData) GetKeyID ¶ added in v1.21.4 

func (o *EncryptedData) GetKeyID() *string

func (*EncryptedData) GetName ¶ added in v1.21.4 

func (o *EncryptedData) GetName() *string

func (*EncryptedData) GetProvider ¶ added in v1.21.4 

func (o *EncryptedData) GetProvider() *string

func (*EncryptedData) GetSchema ¶ added in v1.21.4 

func (o *EncryptedData) GetSchema() *string

type EnrollmentBehavior ¶ added in v1.21.3 

type EnrollmentBehavior string

EnrollmentBehavior - Defines how to handle the request policies of the entitlements in the catalog during enrollment. 

const (
	EnrollmentBehaviorRequestCatalogEnrollmentBehaviorUnspecified                     EnrollmentBehavior = "REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_UNSPECIFIED"
	EnrollmentBehaviorRequestCatalogEnrollmentBehaviorBypassEntitlementRequestPolicy  EnrollmentBehavior = "REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_BYPASS_ENTITLEMENT_REQUEST_POLICY"
	EnrollmentBehaviorRequestCatalogEnrollmentBehaviorEnforceEntitlementRequestPolicy EnrollmentBehavior = "REQUEST_CATALOG_ENROLLMENT_BEHAVIOR_ENFORCE_ENTITLEMENT_REQUEST_POLICY"
)

func (EnrollmentBehavior) ToPointer ¶ added in v1.21.3 

func (e EnrollmentBehavior) ToPointer() *EnrollmentBehavior

type EntitlementOwnerApproval ¶ added in v1.0.3 

type EntitlementOwnerApproval struct {
	// Configuration to allow self approval if the target user is an entitlement owner during this step.
	AllowSelfApproval *bool `json:"allowSelfApproval,omitempty"`
	// Configuration to allow a fallback if the entitlement owner cannot be identified.
	Fallback *bool `json:"fallback,omitempty"`
	// Configuration to specific which users to fallback to if fallback is enabled and the entitlement owner cannot be identified.
	FallbackUserIds []string `json:"fallbackUserIds,omitempty"`
}

EntitlementOwnerApproval - The entitlement owner approval allows configuration of the approval step when the target approvers are the entitlement owners.

func (*EntitlementOwnerApproval) GetAllowSelfApproval ¶ added in v1.6.1 

func (o *EntitlementOwnerApproval) GetAllowSelfApproval() *bool

func (*EntitlementOwnerApproval) GetFallback ¶ added in v1.6.1 

func (o *EntitlementOwnerApproval) GetFallback() *bool

func (*EntitlementOwnerApproval) GetFallbackUserIds ¶ added in v1.6.1 

func (o *EntitlementOwnerApproval) GetFallbackUserIds() []string

type ErroredAction ¶ added in v1.0.3 

type ErroredAction struct {
	// The description of a provision instance that has errored.
	Description *string `json:"description,omitempty"`
	// The error code of a provision instance that has errored. This is only PEC-1 for now, but more will be added in the future.
	ErrorCode *string    `json:"errorCode,omitempty"`
	ErroredAt *time.Time `json:"erroredAt,omitempty"`
}

ErroredAction - The outcome of a provision instance that has errored.

func (*ErroredAction) GetDescription ¶ added in v1.6.1 

func (o *ErroredAction) GetDescription() *string

func (*ErroredAction) GetErrorCode ¶ added in v1.6.1 

func (o *ErroredAction) GetErrorCode() *string

func (*ErroredAction) GetErroredAt ¶ added in v1.6.1 

func (o *ErroredAction) GetErroredAt() *time.Time

func (ErroredAction) MarshalJSON ¶ added in v1.10.1 

func (e ErroredAction) MarshalJSON() ([]byte, error)

func (*ErroredAction) UnmarshalJSON ¶ added in v1.10.1 

func (e *ErroredAction) UnmarshalJSON(data []byte) error

type EventType ¶ added in v1.20.0 

type EventType string

EventType - The eventType field. 

const (
	EventTypeGrantEventTypeUnspecified EventType = "GRANT_EVENT_TYPE_UNSPECIFIED"
	EventTypeGrantEventTypeAdded       EventType = "GRANT_EVENT_TYPE_ADDED"
	EventTypeGrantEventTypeRemoved     EventType = "GRANT_EVENT_TYPE_REMOVED"
)

func (EventType) ToPointer ¶ added in v1.20.0 

func (e EventType) ToPointer() *EventType

type Expanded ¶ added in v1.15.0 

type Expanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

Expanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*Expanded) GetAdditionalProperties ¶ added in v1.15.0 

func (o *Expanded) GetAdditionalProperties() map[string]any

func (*Expanded) GetAtType ¶ added in v1.15.0 

func (o *Expanded) GetAtType() *string

func (Expanded) MarshalJSON ¶ added in v1.15.0 

func (e Expanded) MarshalJSON() ([]byte, error)

func (*Expanded) UnmarshalJSON ¶ added in v1.15.0 

func (e *Expanded) UnmarshalJSON(data []byte) error

type ExportServiceCreateRequest ¶ added in v1.19.0 

type ExportServiceCreateRequest struct {
	// The ExportToDatasource message.
	ExportToDatasource *ExportToDatasource `json:"datasource,omitempty"`
	// The display name of the new policy.
	DisplayName *string `json:"displayName,omitempty"`
}

The ExportServiceCreateRequest message is used to create a new system log exporter.

This message contains a oneof named export_to. Only a single field of the following list may be set at a time:

  • datasource

func (*ExportServiceCreateRequest) GetDisplayName ¶ added in v1.19.0 

func (o *ExportServiceCreateRequest) GetDisplayName() *string

func (*ExportServiceCreateRequest) GetExportToDatasource ¶ added in v1.19.0 

func (o *ExportServiceCreateRequest) GetExportToDatasource() *ExportToDatasource

type ExportServiceCreateResponse ¶ added in v1.19.0 

type ExportServiceCreateResponse struct {
	// The Exporter message.
	//
	// This message contains a oneof named export_to. Only a single field of the following list may be set at a time:
	//   - datasource
	//
	Exporter *Exporter `json:"exporter,omitempty"`
}

The ExportServiceCreateResponse message.

func (*ExportServiceCreateResponse) GetExporter ¶ added in v1.19.0 

func (o *ExportServiceCreateResponse) GetExporter() *Exporter

type ExportServiceDeleteRequest ¶ added in v1.19.0 

type ExportServiceDeleteRequest struct {
}

The ExportServiceDeleteRequest message.

type ExportServiceDeleteResponse ¶ added in v1.19.0 

type ExportServiceDeleteResponse struct {
}

The ExportServiceDeleteResponse message.

type ExportServiceGetResponse ¶ added in v1.19.0 

type ExportServiceGetResponse struct {
	// The Exporter message.
	//
	// This message contains a oneof named export_to. Only a single field of the following list may be set at a time:
	//   - datasource
	//
	Exporter *Exporter `json:"exporter,omitempty"`
}

The ExportServiceGetResponse message contains the system log exporter object.

func (*ExportServiceGetResponse) GetExporter ¶ added in v1.19.0 

func (o *ExportServiceGetResponse) GetExporter() *Exporter

type ExportServiceListEventsRequest ¶ added in v1.20.0 

type ExportServiceListEventsRequest struct {
	// The pageSize field.
	PageSize *int `json:"pageSize,omitempty"`
	// The pageToken field.
	PageToken *string `json:"pageToken,omitempty"`
}

The ExportServiceListEventsRequest message.

func (*ExportServiceListEventsRequest) GetPageSize ¶ added in v1.20.0 

func (o *ExportServiceListEventsRequest) GetPageSize() *int

func (*ExportServiceListEventsRequest) GetPageToken ¶ added in v1.20.0 

func (o *ExportServiceListEventsRequest) GetPageToken() *string

type ExportServiceListEventsResponse ¶ added in v1.20.0 

type ExportServiceListEventsResponse struct {
	// List contains an array of JSON OCSF events.
	List []map[string]any `json:"list,omitempty"`
	// The nextPageToken field.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The ExportServiceListEventsResponse message.

func (*ExportServiceListEventsResponse) GetList ¶ added in v1.20.0 

func (o *ExportServiceListEventsResponse) GetList() []map[string]any

func (*ExportServiceListEventsResponse) GetNextPageToken ¶ added in v1.20.0 

func (o *ExportServiceListEventsResponse) GetNextPageToken() *string

type ExportServiceListResponse ¶ added in v1.19.0 

type ExportServiceListResponse struct {
	// The list of results containing up to X results, where X is the page size defined in the request
	List []Exporter `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The ExportServiceListResponse message.

func (*ExportServiceListResponse) GetList ¶ added in v1.19.0 

func (o *ExportServiceListResponse) GetList() []Exporter

func (*ExportServiceListResponse) GetNextPageToken ¶ added in v1.19.0 

func (o *ExportServiceListResponse) GetNextPageToken() *string

type ExportServiceUpdateRequest ¶ added in v1.19.0 

type ExportServiceUpdateRequest struct {
	// The Exporter message.
	//
	// This message contains a oneof named export_to. Only a single field of the following list may be set at a time:
	//   - datasource
	//
	Exporter   *ExporterInput `json:"exporter,omitempty"`
	UpdateMask *string        `json:"updateMask,omitempty"`
}

The ExportServiceUpdateRequest message.

func (*ExportServiceUpdateRequest) GetExporter ¶ added in v1.19.0 

func (o *ExportServiceUpdateRequest) GetExporter() *ExporterInput

func (*ExportServiceUpdateRequest) GetUpdateMask ¶ added in v1.19.0 

func (o *ExportServiceUpdateRequest) GetUpdateMask() *string

type ExportServiceUpdateResponse ¶ added in v1.19.0 

type ExportServiceUpdateResponse struct {
	// The Exporter message.
	//
	// This message contains a oneof named export_to. Only a single field of the following list may be set at a time:
	//   - datasource
	//
	Exporter *Exporter `json:"exporter,omitempty"`
}

The ExportServiceUpdateResponse message.

func (*ExportServiceUpdateResponse) GetExporter ¶ added in v1.19.0 

func (o *ExportServiceUpdateResponse) GetExporter() *Exporter

type ExportToDatasource ¶ added in v1.19.0 

type ExportToDatasource struct {
	// The datasourceId field.
	DatasourceID *string `json:"datasourceId,omitempty"`
	// The format field.
	Format *Format `json:"format,omitempty"`
	// The prefix field.
	Prefix *string `json:"prefix,omitempty"`
}

The ExportToDatasource message.

func (*ExportToDatasource) GetDatasourceID ¶ added in v1.19.0 

func (o *ExportToDatasource) GetDatasourceID() *string

func (*ExportToDatasource) GetFormat ¶ added in v1.19.0 

func (o *ExportToDatasource) GetFormat() *Format

func (*ExportToDatasource) GetPrefix ¶ added in v1.19.0 

func (o *ExportToDatasource) GetPrefix() *string

type Exporter ¶ added in v1.19.0 

type Exporter struct {
	// The ExportToDatasource message.
	ExportToDatasource *ExportToDatasource `json:"datasource,omitempty"`
	CreatedAt          *time.Time          `json:"createdAt,omitempty"`
	DeletedAt          *time.Time          `json:"deletedAt,omitempty"`
	// The displayName field.
	DisplayName *string `json:"displayName,omitempty"`
	// The exportId field.
	ExportID *string `json:"exportId,omitempty"`
	// The state field.
	State     *ExporterState `json:"state,omitempty"`
	UpdatedAt *time.Time     `json:"updatedAt,omitempty"`
	// we've synchorized this far
	WatermarkEventID *string `json:"watermarkEventId,omitempty"`
}

The Exporter message.

This message contains a oneof named export_to. Only a single field of the following list may be set at a time:

  • datasource

func (*Exporter) GetCreatedAt ¶ added in v1.19.0 

func (o *Exporter) GetCreatedAt() *time.Time

func (*Exporter) GetDeletedAt ¶ added in v1.19.0 

func (o *Exporter) GetDeletedAt() *time.Time

func (*Exporter) GetDisplayName ¶ added in v1.19.0 

func (o *Exporter) GetDisplayName() *string

func (*Exporter) GetExportID ¶ added in v1.19.0 

func (o *Exporter) GetExportID() *string

func (*Exporter) GetExportToDatasource ¶ added in v1.19.0 

func (o *Exporter) GetExportToDatasource() *ExportToDatasource

func (*Exporter) GetState ¶ added in v1.19.0 

func (o *Exporter) GetState() *ExporterState

func (*Exporter) GetUpdatedAt ¶ added in v1.19.0 

func (o *Exporter) GetUpdatedAt() *time.Time

func (*Exporter) GetWatermarkEventID ¶ added in v1.19.0 

func (o *Exporter) GetWatermarkEventID() *string

func (Exporter) MarshalJSON ¶ added in v1.19.0 

func (e Exporter) MarshalJSON() ([]byte, error)

func (*Exporter) UnmarshalJSON ¶ added in v1.19.0 

func (e *Exporter) UnmarshalJSON(data []byte) error

type ExporterInput ¶ added in v1.19.0 

type ExporterInput struct {
	// The ExportToDatasource message.
	ExportToDatasource *ExportToDatasource `json:"datasource,omitempty"`
	// The displayName field.
	DisplayName *string `json:"displayName,omitempty"`
}

ExporterInput - The Exporter message.

This message contains a oneof named export_to. Only a single field of the following list may be set at a time:

  • datasource

func (*ExporterInput) GetDisplayName ¶ added in v1.19.0 

func (o *ExporterInput) GetDisplayName() *string

func (*ExporterInput) GetExportToDatasource ¶ added in v1.19.0 

func (o *ExporterInput) GetExportToDatasource() *ExportToDatasource

type ExporterRef ¶ added in v1.19.0 

type ExporterRef struct {
	// The exportId field.
	ExportID *string `json:"exportId,omitempty"`
}

The ExporterRef message.

func (*ExporterRef) GetExportID ¶ added in v1.19.0 

func (o *ExporterRef) GetExportID() *string

type ExporterState ¶ added in v1.19.0 

type ExporterState string

ExporterState - The state field. 

const (
	ExporterStateExportStateUnspecified ExporterState = "EXPORT_STATE_UNSPECIFIED"
	ExporterStateExportStateExporting   ExporterState = "EXPORT_STATE_EXPORTING"
	ExporterStateExportStateWaiting     ExporterState = "EXPORT_STATE_WAITING"
	ExporterStateExportStateError       ExporterState = "EXPORT_STATE_ERROR"
)

func (ExporterState) ToPointer ¶ added in v1.19.0 

func (e ExporterState) ToPointer() *ExporterState

type ExportsSearchServiceSearchRequest ¶ added in v1.19.0 

type ExportsSearchServiceSearchRequest struct {
	// Search for system log exporters with a case insensitive match on the display name.
	DisplayName *string `json:"displayName,omitempty"`
	// The pageSize field.
	PageSize *int `json:"pageSize,omitempty"`
	// The pageToken field.
	PageToken *string `json:"pageToken,omitempty"`
	// The query field.
	Query *string `json:"query,omitempty"`
	// The refs field.
	Refs []ExporterRef `json:"refs,omitempty"`
}

The ExportsSearchServiceSearchRequest message.

func (*ExportsSearchServiceSearchRequest) GetDisplayName ¶ added in v1.19.0 

func (o *ExportsSearchServiceSearchRequest) GetDisplayName() *string

func (*ExportsSearchServiceSearchRequest) GetPageSize ¶ added in v1.19.0 

func (o *ExportsSearchServiceSearchRequest) GetPageSize() *int

func (*ExportsSearchServiceSearchRequest) GetPageToken ¶ added in v1.19.0 

func (o *ExportsSearchServiceSearchRequest) GetPageToken() *string

func (*ExportsSearchServiceSearchRequest) GetQuery ¶ added in v1.19.0 

func (o *ExportsSearchServiceSearchRequest) GetQuery() *string

func (*ExportsSearchServiceSearchRequest) GetRefs ¶ added in v1.19.0 

func (o *ExportsSearchServiceSearchRequest) GetRefs() []ExporterRef

type ExportsSearchServiceSearchResponse ¶ added in v1.19.0 

type ExportsSearchServiceSearchResponse struct {
	// The list field.
	List []Exporter `json:"list,omitempty"`
	// The nextPageToken field.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The ExportsSearchServiceSearchResponse message.

func (*ExportsSearchServiceSearchResponse) GetList ¶ added in v1.19.0 

func (o *ExportsSearchServiceSearchResponse) GetList() []Exporter

func (*ExportsSearchServiceSearchResponse) GetNextPageToken ¶ added in v1.19.0 

func (o *ExportsSearchServiceSearchResponse) GetNextPageToken() *string

type ExpressionApproval ¶ added in v1.9.0 

type ExpressionApproval struct {
	// Configuration to allow self approval of if the user is specified and also the target of the ticket.
	AllowSelfApproval *bool `json:"allowSelfApproval,omitempty"`
	// The assignedUserIds field.
	AssignedUserIds []string `json:"assignedUserIds,omitempty"`
	// Array of dynamic expressions to determine the approvers.  The first expression to return a non-empty list of users will be used.
	Expressions []string `json:"expressions,omitempty"`
	// Configuration to allow a fallback if the expression does not return a valid list of users.
	Fallback *bool `json:"fallback,omitempty"`
	// Configuration to specific which users to fallback to if and the expression does not return a valid list of users.
	FallbackUserIds []string `json:"fallbackUserIds,omitempty"`
}

The ExpressionApproval message.

func (*ExpressionApproval) GetAllowSelfApproval ¶ added in v1.9.0 

func (o *ExpressionApproval) GetAllowSelfApproval() *bool

func (*ExpressionApproval) GetAssignedUserIds ¶ added in v1.9.0 

func (o *ExpressionApproval) GetAssignedUserIds() []string

func (*ExpressionApproval) GetExpressions ¶ added in v1.9.0 

func (o *ExpressionApproval) GetExpressions() []string

func (*ExpressionApproval) GetFallback ¶ added in v1.9.0 

func (o *ExpressionApproval) GetFallback() *bool

func (*ExpressionApproval) GetFallbackUserIds ¶ added in v1.9.0 

func (o *ExpressionApproval) GetFallbackUserIds() []string

type ExternalRef ¶ added in v1.0.3 

type ExternalRef struct {
	// The source of the external reference.
	ExternalRefSource *ExternalRefSource `json:"externalRefSource,omitempty"`
	// The name of the external reference.
	Name *string `json:"name,omitempty"`
	// The URL to the external reference.
	URL *string `json:"url,omitempty"`
}

ExternalRef - A reference to an external source. This value is unused currently, but may be brought back.

func (*ExternalRef) GetExternalRefSource ¶ added in v1.6.1 

func (o *ExternalRef) GetExternalRefSource() *ExternalRefSource

func (*ExternalRef) GetName ¶ added in v1.6.1 

func (o *ExternalRef) GetName() *string

func (*ExternalRef) GetURL ¶ added in v1.6.1 

func (o *ExternalRef) GetURL() *string

type ExternalRefSource ¶ added in v1.15.0 

type ExternalRefSource string

ExternalRefSource - The source of the external reference. 

const (
	ExternalRefSourceUnspecified ExternalRefSource = "UNSPECIFIED"
	ExternalRefSourceJira        ExternalRefSource = "JIRA"
)

func (ExternalRefSource) ToPointer ¶ added in v1.15.0 

func (e ExternalRefSource) ToPointer() *ExternalRefSource

type ExternalTicketProvision ¶ added in v1.18.3 

type ExternalTicketProvision struct {
	// The appId field.
	AppID *string `json:"appId,omitempty"`
	// The connectorId field.
	ConnectorID *string `json:"connectorId,omitempty"`
	// The externalTicketProvisionerConfigId field.
	ExternalTicketProvisionerConfigID *string `json:"externalTicketProvisionerConfigId,omitempty"`
	// This field indicates a text body of instructions for the provisioner to indicate.
	Instructions *string `json:"instructions,omitempty"`
}

ExternalTicketProvision - This provision step indicates that we should check an external ticket to provision this entitlement

func (*ExternalTicketProvision) GetAppID ¶ added in v1.18.3 

func (o *ExternalTicketProvision) GetAppID() *string

func (*ExternalTicketProvision) GetConnectorID ¶ added in v1.18.3 

func (o *ExternalTicketProvision) GetConnectorID() *string

func (*ExternalTicketProvision) GetExternalTicketProvisionerConfigID ¶ added in v1.18.3 

func (o *ExternalTicketProvision) GetExternalTicketProvisionerConfigID() *string

func (*ExternalTicketProvision) GetInstructions ¶ added in v1.20.0 

func (o *ExternalTicketProvision) GetInstructions() *string

type FacetCategory ¶ added in v1.7.0 

type FacetCategory struct {
	// The FacetRangeItem message.
	FacetRangeItem *FacetRangeItem `json:"range,omitempty"`
	// The FacetValueItem message.
	FacetValueItem *FacetValueItem `json:"value,omitempty"`
	// The display name of the category.
	DisplayName *string `json:"displayName,omitempty"`
	// An icon for the category.
	IconURL *string `json:"iconUrl,omitempty"`
	// The param that is being set when checking a facet in this category.
	Param *string `json:"param,omitempty"`
}

The FacetCategory indicates a grouping of facets by type. For example, facets "OnePassword" and "Okta" would group under an "Apps" category.

This message contains a oneof named item. Only a single field of the following list may be set at a time:

  • value
  • range

func (*FacetCategory) GetDisplayName ¶ added in v1.7.0 

func (o *FacetCategory) GetDisplayName() *string

func (*FacetCategory) GetFacetRangeItem ¶ added in v1.7.0 

func (o *FacetCategory) GetFacetRangeItem() *FacetRangeItem

func (*FacetCategory) GetFacetValueItem ¶ added in v1.7.0 

func (o *FacetCategory) GetFacetValueItem() *FacetValueItem

func (*FacetCategory) GetIconURL ¶ added in v1.7.0 

func (o *FacetCategory) GetIconURL() *string

func (*FacetCategory) GetParam ¶ added in v1.7.0 

func (o *FacetCategory) GetParam() *string

type FacetRange ¶ added in v1.7.0 

type FacetRange struct {
	// The count of items in the range.
	Count *int64 `integer:"string" json:"count,omitempty"`
	// The display name of the range.
	DisplayName *string `json:"displayName,omitempty"`
	// The starting value of the range.
	From *int64 `integer:"string" json:"from,omitempty"`
	// The icon of the range.
	IconURL *string `json:"iconUrl,omitempty"`
	// The ending value of the range.
	To *int64 `integer:"string" json:"to,omitempty"`
}

The FacetRange message.

func (*FacetRange) GetCount ¶ added in v1.7.0 

func (o *FacetRange) GetCount() *int64

func (*FacetRange) GetDisplayName ¶ added in v1.7.0 

func (o *FacetRange) GetDisplayName() *string

func (*FacetRange) GetFrom ¶ added in v1.7.0 

func (o *FacetRange) GetFrom() *int64

func (*FacetRange) GetIconURL ¶ added in v1.7.0 

func (o *FacetRange) GetIconURL() *string

func (*FacetRange) GetTo ¶ added in v1.7.0 

func (o *FacetRange) GetTo() *int64

type FacetRangeItem ¶ added in v1.7.0 

type FacetRangeItem struct {
	// An array of facet ranges.
	Ranges []FacetRange `json:"ranges,omitempty"`
}

The FacetRangeItem message.

func (*FacetRangeItem) GetRanges ¶ added in v1.7.0 

func (o *FacetRangeItem) GetRanges() []FacetRange

type FacetValue ¶ added in v1.7.0 

type FacetValue struct {
	// The count of the values in this facet.
	Count *int64 `integer:"string" json:"count,omitempty"`
	// The name of this facet.
	DisplayName *string `json:"displayName,omitempty"`
	// The icon for this facet.
	IconURL *string `json:"iconUrl,omitempty"`
	// The value of this facet.
	Value *string `json:"value,omitempty"`
}

A FacetValue message contains count and value of the facet entry.

func (*FacetValue) GetCount ¶ added in v1.7.0 

func (o *FacetValue) GetCount() *int64

func (*FacetValue) GetDisplayName ¶ added in v1.7.0 

func (o *FacetValue) GetDisplayName() *string

func (*FacetValue) GetIconURL ¶ added in v1.7.0 

func (o *FacetValue) GetIconURL() *string

func (*FacetValue) GetValue ¶ added in v1.7.0 

func (o *FacetValue) GetValue() *string

type FacetValueItem ¶ added in v1.7.0 

type FacetValueItem struct {
	// An array of facet values.
	Values []FacetValue `json:"values,omitempty"`
}

The FacetValueItem message.

func (*FacetValueItem) GetValues ¶ added in v1.7.0 

func (o *FacetValueItem) GetValues() []FacetValue

type Facets ¶ added in v1.7.0 

type Facets struct {
	// The count of items in this facet.
	Count *int64 `integer:"string" json:"count,omitempty"`
	// The facet being referenced.
	Facets []FacetCategory `json:"facets,omitempty"`
}

Facets - Indicates one value of a facet.

func (*Facets) GetCount ¶ added in v1.7.0 

func (o *Facets) GetCount() *int64

func (*Facets) GetFacets ¶ added in v1.7.0 

func (o *Facets) GetFacets() []FacetCategory

type ForceRunBundleAutomationRequest ¶ added in v1.20.0 

type ForceRunBundleAutomationRequest struct {
	// The refs field.
	Refs []AppEntitlementRef `json:"refs,omitempty"`
}

The ForceRunBundleAutomationRequest message.

func (*ForceRunBundleAutomationRequest) GetRefs ¶ added in v1.20.0 

func (o *ForceRunBundleAutomationRequest) GetRefs() []AppEntitlementRef

type ForceRunBundleAutomationResponse ¶ added in v1.20.0 

type ForceRunBundleAutomationResponse struct {
}

The ForceRunBundleAutomationResponse message.

type ForceSyncRequest ¶ added in v1.18.3 

type ForceSyncRequest struct {
}

ForceSyncRequest - Signal the connector to start syncing. This puts the sync on the queue. It does not guarantee immediate sync. Long syncs still take minutes to hours.

type ForceSyncResponse ¶ added in v1.18.3 

type ForceSyncResponse struct {
}

The ForceSyncResponse message.

type Format ¶ added in v1.19.0 

type Format string

Format - The format field. 

const (
	FormatExportFormatUnspecified  Format = "EXPORT_FORMAT_UNSPECIFIED"
	FormatExportFormatOcsfJSONZstd Format = "EXPORT_FORMAT_OCSF_JSON_ZSTD"
	FormatExportFormatOcsfJSONGzip Format = "EXPORT_FORMAT_OCSF_JSON_GZIP"
)

func (Format) ToPointer ¶ added in v1.19.0 

func (e Format) ToPointer() *Format

type GetAWSExternalIDResponse ¶ added in v1.16.0 

type GetAWSExternalIDResponse struct {
	// The AWSExternalID message.
	AWSExternalID *AWSExternalID `json:"awsExternalId,omitempty"`
}

The GetAWSExternalIDResponse message.

func (*GetAWSExternalIDResponse) GetAWSExternalID ¶ added in v1.16.0 

func (o *GetAWSExternalIDResponse) GetAWSExternalID() *AWSExternalID

type GetAppEntitlementProxyResponse ¶ added in v1.21.3 

type GetAppEntitlementProxyResponse struct {
	// The AppEntitlementProxyView message.
	AppEntitlementProxyView *AppEntitlementProxyView `json:"appProxyEntitlementView,omitempty"`
	// The expanded field.
	Expanded []GetAppEntitlementProxyResponseExpanded `json:"expanded,omitempty"`
}

The GetAppEntitlementProxyResponse message.

func (*GetAppEntitlementProxyResponse) GetAppEntitlementProxyView ¶ added in v1.21.3 

func (o *GetAppEntitlementProxyResponse) GetAppEntitlementProxyView() *AppEntitlementProxyView

func (*GetAppEntitlementProxyResponse) GetExpanded ¶ added in v1.21.3 

func (o *GetAppEntitlementProxyResponse) GetExpanded() []GetAppEntitlementProxyResponseExpanded

type GetAppEntitlementProxyResponseExpanded ¶ added in v1.21.3 

type GetAppEntitlementProxyResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

GetAppEntitlementProxyResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*GetAppEntitlementProxyResponseExpanded) GetAdditionalProperties ¶ added in v1.21.3 

func (o *GetAppEntitlementProxyResponseExpanded) GetAdditionalProperties() map[string]any

func (*GetAppEntitlementProxyResponseExpanded) GetAtType ¶ added in v1.21.3 

func (o *GetAppEntitlementProxyResponseExpanded) GetAtType() *string

func (GetAppEntitlementProxyResponseExpanded) MarshalJSON ¶ added in v1.21.3 

func (g GetAppEntitlementProxyResponseExpanded) MarshalJSON() ([]byte, error)

func (*GetAppEntitlementProxyResponseExpanded) UnmarshalJSON ¶ added in v1.21.3 

func (g *GetAppEntitlementProxyResponseExpanded) UnmarshalJSON(data []byte) error

type GetAppEntitlementResponse ¶ added in v1.0.3 

type GetAppEntitlementResponse struct {
	// The app entitlement view contains the serialized app entitlement and paths to objects referenced by the app entitlement.
	AppEntitlementView *AppEntitlementView `json:"appEntitlementView,omitempty"`
	// List of serialized related objects.
	Expanded []GetAppEntitlementResponseExpanded `json:"expanded,omitempty"`
}

GetAppEntitlementResponse - The get app entitlement response returns an entitlement view containing paths in the expanded array for the objects expanded as indicated by the expand mask in the request.

func (*GetAppEntitlementResponse) GetAppEntitlementView ¶ added in v1.6.1 

func (o *GetAppEntitlementResponse) GetAppEntitlementView() *AppEntitlementView

func (*GetAppEntitlementResponse) GetExpanded ¶ added in v1.6.1 

func (o *GetAppEntitlementResponse) GetExpanded() []GetAppEntitlementResponseExpanded

type GetAppEntitlementResponseExpanded ¶ added in v1.10.1 

type GetAppEntitlementResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

GetAppEntitlementResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*GetAppEntitlementResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *GetAppEntitlementResponseExpanded) GetAdditionalProperties() map[string]any

func (*GetAppEntitlementResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *GetAppEntitlementResponseExpanded) GetAtType() *string

func (GetAppEntitlementResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (g GetAppEntitlementResponseExpanded) MarshalJSON() ([]byte, error)

func (*GetAppEntitlementResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (g *GetAppEntitlementResponseExpanded) UnmarshalJSON(data []byte) error

type GetAppResponse ¶ added in v1.0.3 

type GetAppResponse struct {
	// The App object provides all of the details for an app, as well as some configuration.
	App *App `json:"app,omitempty"`
}

The GetAppResponse message contains the details of the requested app in the app field.

func (*GetAppResponse) GetApp ¶ added in v1.6.1 

func (o *GetAppResponse) GetApp() *App

type GetAppUsageControlsResponse ¶ added in v1.0.3 

type GetAppUsageControlsResponse struct {
	// The AppUsageControls object describes some peripheral configuration for an app.
	AppUsageControls *AppUsageControls `json:"appUsageControls,omitempty"`
	// HasUsageData is false if the access entitlement for this app has no usage data.
	HasUsageData *bool `json:"hasUsageData,omitempty"`
}

The GetAppUsageControlsResponse message contains the retrieved AppUsageControls object.

func (*GetAppUsageControlsResponse) GetAppUsageControls ¶ added in v1.6.1 

func (o *GetAppUsageControlsResponse) GetAppUsageControls() *AppUsageControls

func (*GetAppUsageControlsResponse) GetHasUsageData ¶ added in v1.6.1 

func (o *GetAppUsageControlsResponse) GetHasUsageData() *bool

type GetAttributeValueResponse ¶ added in v1.8.0 

type GetAttributeValueResponse struct {
	// AttributeValue is the value of an attribute of a defined type.
	AttributeValue *AttributeValue `json:"value,omitempty"`
}

GetAttributeValueResponse is the response for getting an attribute value by id.

func (*GetAttributeValueResponse) GetAttributeValue ¶ added in v1.8.0 

func (o *GetAttributeValueResponse) GetAttributeValue() *AttributeValue

type GetPolicyResponse ¶ added in v1.1.1 

type GetPolicyResponse struct {
	// A policy describes the behavior of the ConductorOne system when processing a task. You can describe the type, approvers, fallback behavior, and escalation processes.
	Policy *Policy `json:"policy,omitempty"`
}

The GetPolicyResponse message contains the policy object.

func (*GetPolicyResponse) GetPolicy ¶ added in v1.6.1 

func (o *GetPolicyResponse) GetPolicy() *Policy

type GetRolesResponse ¶ added in v1.1.1 

type GetRolesResponse struct {
	// Role is a role that can be assigned to a user in ConductorOne.
	Role *Role `json:"role,omitempty"`
}

The GetRolesResponse message contains the retrieved role.

func (*GetRolesResponse) GetRole ¶ added in v1.6.1 

func (o *GetRolesResponse) GetRole() *Role

type GetSessionSettingsResponse ¶ added in v1.16.0 

type GetSessionSettingsResponse struct {
	// The SessionSettings message.
	SessionSettings *SessionSettings `json:"sessionSettings,omitempty"`
}

The GetSessionSettingsResponse message.

func (*GetSessionSettingsResponse) GetSessionSettings ¶ added in v1.16.0 

func (o *GetSessionSettingsResponse) GetSessionSettings() *SessionSettings

type GrantReason ¶ added in v1.20.0 

type GrantReason struct {
	// The ID of the app entitlement that is associated with the grant reason.
	AppEntitlementID *string `json:"appEntitlementId,omitempty"`
	// The ID of the app that is associated with the grant reason.
	AppID *string `json:"appId,omitempty"`
	// The ID of the app user that is associated with the grant reason.
	AppUserID *string    `json:"appUserId,omitempty"`
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
	// This is the other part of the derived ID which include the details like ticket_id, group_id, etc. This provides the uniqueness.
	DerivedIDData *string `json:"derivedIdData,omitempty"`
	// This is one part of the derived ID, indicating the type, like "ticket" or "group"
	DerivedIDType   *string    `json:"derivedIdType,omitempty"`
	ReasonExpiresAt *time.Time `json:"reasonExpiresAt,omitempty"`
	// GrantReasonReferenceStrength is used to indicate the strength of the reference to the reason.
	//  This is used to determine if a grant should be removed when all strong reasons are removed.
	ReferenceStrength *ReferenceStrength `json:"referenceStrength,omitempty"`
	UpdatedAt         *time.Time         `json:"updatedAt,omitempty"`
}

The GrantReason message.

func (*GrantReason) GetAppEntitlementID ¶ added in v1.20.0 

func (o *GrantReason) GetAppEntitlementID() *string

func (*GrantReason) GetAppID ¶ added in v1.20.0 

func (o *GrantReason) GetAppID() *string

func (*GrantReason) GetAppUserID ¶ added in v1.20.0 

func (o *GrantReason) GetAppUserID() *string

func (*GrantReason) GetCreatedAt ¶ added in v1.20.0 

func (o *GrantReason) GetCreatedAt() *time.Time

func (*GrantReason) GetDeletedAt ¶ added in v1.20.0 

func (o *GrantReason) GetDeletedAt() *time.Time

func (*GrantReason) GetDerivedIDData ¶ added in v1.20.0 

func (o *GrantReason) GetDerivedIDData() *string

func (*GrantReason) GetDerivedIDType ¶ added in v1.20.0 

func (o *GrantReason) GetDerivedIDType() *string

func (*GrantReason) GetReasonExpiresAt ¶ added in v1.20.0 

func (o *GrantReason) GetReasonExpiresAt() *time.Time

func (*GrantReason) GetReferenceStrength ¶ added in v1.20.0 

func (o *GrantReason) GetReferenceStrength() *ReferenceStrength

func (*GrantReason) GetUpdatedAt ¶ added in v1.20.0 

func (o *GrantReason) GetUpdatedAt() *time.Time

func (GrantReason) MarshalJSON ¶ added in v1.20.0 

func (g GrantReason) MarshalJSON() ([]byte, error)

func (*GrantReason) UnmarshalJSON ¶ added in v1.20.0 

func (g *GrantReason) UnmarshalJSON(data []byte) error

type GrantedStatus ¶ added in v1.15.0 

type GrantedStatus string

GrantedStatus - Search entitlements with this granted status for your signed in user. 

const (
	GrantedStatusUnspecified GrantedStatus = "UNSPECIFIED"
	GrantedStatusAll         GrantedStatus = "ALL"
	GrantedStatusGranted     GrantedStatus = "GRANTED"
	GrantedStatusNotGranted  GrantedStatus = "NOT_GRANTED"
)

func (GrantedStatus) ToPointer ¶ added in v1.15.0 

func (e GrantedStatus) ToPointer() *GrantedStatus

type IdentityMatching ¶ added in v1.18.3 

type IdentityMatching string

IdentityMatching - The identityMatching field. 

const (
	IdentityMatchingAppUserIdentityMatchingUnspecified IdentityMatching = "APP_USER_IDENTITY_MATCHING_UNSPECIFIED"
	IdentityMatchingAppUserIdentityMatchingStrict      IdentityMatching = "APP_USER_IDENTITY_MATCHING_STRICT"
	IdentityMatchingAppUserIdentityMatchingDisplayName IdentityMatching = "APP_USER_IDENTITY_MATCHING_DISPLAY_NAME"
)

func (IdentityMatching) ToPointer ¶ added in v1.18.3 

func (e IdentityMatching) ToPointer() *IdentityMatching

type IntrospectResponse ¶ added in v1.0.3 

type IntrospectResponse struct {
	// The list of feature flags enabled for the tenant the logged in user belongs to.
	Features []string `json:"features,omitempty"`
	// The list of permissions that the current logged in user has.
	Permissions []string `json:"permissions,omitempty"`
	// The principleID of the current logged in user.
	PrincipleID *string `json:"principleId,omitempty"`
	// The list of roles that the current logged in user has.
	Roles []string `json:"roles,omitempty"`
	// The userID of the current logged in user.
	UserID *string `json:"userId,omitempty"`
}

IntrospectResponse contains information about the current user who is authenticated.

func (*IntrospectResponse) GetFeatures ¶ added in v1.6.1 

func (o *IntrospectResponse) GetFeatures() []string

func (*IntrospectResponse) GetPermissions ¶ added in v1.6.1 

func (o *IntrospectResponse) GetPermissions() []string

func (*IntrospectResponse) GetPrincipleID ¶ added in v1.6.1 

func (o *IntrospectResponse) GetPrincipleID() *string

func (*IntrospectResponse) GetRoles ¶ added in v1.6.1 

func (o *IntrospectResponse) GetRoles() []string

func (*IntrospectResponse) GetUserID ¶ added in v1.6.1 

func (o *IntrospectResponse) GetUserID() *string

type ListAppEntitlementOwnersResponse ¶ added in v1.8.0 

type ListAppEntitlementOwnersResponse struct {
	// The list of owners for the app entitlement.
	List []User `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retreived.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

ListAppEntitlementOwnersResponse - The response message for listing app entitlement owners.

func (*ListAppEntitlementOwnersResponse) GetList ¶ added in v1.8.0 

func (o *ListAppEntitlementOwnersResponse) GetList() []User

func (*ListAppEntitlementOwnersResponse) GetNextPageToken ¶ added in v1.8.0 

func (o *ListAppEntitlementOwnersResponse) GetNextPageToken() *string

type ListAppEntitlementUsersResponse ¶ added in v1.7.0 

type ListAppEntitlementUsersResponse struct {
	// List of related objects
	Expanded []ListAppEntitlementUsersResponseExpanded `json:"expanded,omitempty"`
	// The list of results containing up to X results, where X is the page size defined in the request.
	List []AppEntitlementUserView `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The ListAppEntitlementUsersResponse message contains a list of results and a nextPageToken if applicable.

func (*ListAppEntitlementUsersResponse) GetExpanded ¶ added in v1.7.0 

func (o *ListAppEntitlementUsersResponse) GetExpanded() []ListAppEntitlementUsersResponseExpanded

func (*ListAppEntitlementUsersResponse) GetList ¶ added in v1.7.0 

func (o *ListAppEntitlementUsersResponse) GetList() []AppEntitlementUserView

func (*ListAppEntitlementUsersResponse) GetNextPageToken ¶ added in v1.7.0 

func (o *ListAppEntitlementUsersResponse) GetNextPageToken() *string

type ListAppEntitlementUsersResponseExpanded ¶ added in v1.10.1 

type ListAppEntitlementUsersResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

ListAppEntitlementUsersResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*ListAppEntitlementUsersResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *ListAppEntitlementUsersResponseExpanded) GetAdditionalProperties() map[string]any

func (*ListAppEntitlementUsersResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *ListAppEntitlementUsersResponseExpanded) GetAtType() *string

func (ListAppEntitlementUsersResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (l ListAppEntitlementUsersResponseExpanded) MarshalJSON() ([]byte, error)

func (*ListAppEntitlementUsersResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (l *ListAppEntitlementUsersResponseExpanded) UnmarshalJSON(data []byte) error

type ListAppEntitlementsResponse ¶ added in v1.7.0 

type ListAppEntitlementsResponse struct {
	// List of related objects
	Expanded []ListAppEntitlementsResponseExpanded `json:"expanded,omitempty"`
	// The list of results containing up to X results, where X is the page size defined in the request.
	List []AppEntitlementView `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The ListAppEntitlementsResponse message contains a list of results and a nextPageToken if applicable.

func (*ListAppEntitlementsResponse) GetExpanded ¶ added in v1.7.0 

func (o *ListAppEntitlementsResponse) GetExpanded() []ListAppEntitlementsResponseExpanded

func (*ListAppEntitlementsResponse) GetList ¶ added in v1.7.0 

func (o *ListAppEntitlementsResponse) GetList() []AppEntitlementView

func (*ListAppEntitlementsResponse) GetNextPageToken ¶ added in v1.7.0 

func (o *ListAppEntitlementsResponse) GetNextPageToken() *string

type ListAppEntitlementsResponseExpanded ¶ added in v1.10.1 

type ListAppEntitlementsResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

ListAppEntitlementsResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*ListAppEntitlementsResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *ListAppEntitlementsResponseExpanded) GetAdditionalProperties() map[string]any

func (*ListAppEntitlementsResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *ListAppEntitlementsResponseExpanded) GetAtType() *string

func (ListAppEntitlementsResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (l ListAppEntitlementsResponseExpanded) MarshalJSON() ([]byte, error)

func (*ListAppEntitlementsResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (l *ListAppEntitlementsResponseExpanded) UnmarshalJSON(data []byte) error

type ListAppOwnersResponse ¶ added in v1.1.1 

type ListAppOwnersResponse struct {
	// The list of results containing up to X results, where X is the page size defined in the request
	List []User `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The ListAppOwnersResponse message.

func (*ListAppOwnersResponse) GetList ¶ added in v1.6.1 

func (o *ListAppOwnersResponse) GetList() []User

func (*ListAppOwnersResponse) GetNextPageToken ¶ added in v1.6.1 

func (o *ListAppOwnersResponse) GetNextPageToken() *string

type ListAppResourceOwnersResponse ¶ added in v1.1.1 

type ListAppResourceOwnersResponse struct {
	// The list of results containing up to X results, where X is the page size defined in the request.
	List []User `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retreived.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The ListAppResourceOwnersResponse message contains a list of results and a nextPageToken if applicable

func (*ListAppResourceOwnersResponse) GetList ¶ added in v1.6.1 

func (o *ListAppResourceOwnersResponse) GetList() []User

func (*ListAppResourceOwnersResponse) GetNextPageToken ¶ added in v1.6.1 

func (o *ListAppResourceOwnersResponse) GetNextPageToken() *string

type ListAppUsersForIdentityWithGrantResponse ¶ added in v1.0.3 

type ListAppUsersForIdentityWithGrantResponse struct {
	// The list of app users that may also have grant information.
	//  Without a grant, only the tenant, app, and app user ID will be set. With a grant, the whole struct is populated
	Bindings []AppEntitlementUserBinding `json:"bindings,omitempty"`
}

The ListAppUsersForIdentityWithGrantResponse message.

func (*ListAppUsersForIdentityWithGrantResponse) GetBindings ¶ added in v1.6.1 

func (o *ListAppUsersForIdentityWithGrantResponse) GetBindings() []AppEntitlementUserBinding

type ListAppsResponse ¶ added in v1.0.3 

type ListAppsResponse struct {
	// The list of results containing up to X results, where X is the page size defined in the request.
	List []App `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retreived.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The ListAppsResponse message contains a list of results and a nextPageToken if applicable.

func (*ListAppsResponse) GetList ¶ added in v1.6.1 

func (o *ListAppsResponse) GetList() []App

func (*ListAppsResponse) GetNextPageToken ¶ added in v1.6.1 

func (o *ListAppsResponse) GetNextPageToken() *string

type ListAttributeTypesResponse ¶ added in v1.8.0 

type ListAttributeTypesResponse struct {
	// The list of AttributeTypes.
	List []AttributeType `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retreived.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

ListAttributeTypesResponse is the response for listing attribute types.

func (*ListAttributeTypesResponse) GetList ¶ added in v1.8.0 

func (o *ListAttributeTypesResponse) GetList() []AttributeType

func (*ListAttributeTypesResponse) GetNextPageToken ¶ added in v1.8.0 

func (o *ListAttributeTypesResponse) GetNextPageToken() *string

type ListAttributeValuesResponse ¶ added in v1.8.0 

type ListAttributeValuesResponse struct {
	// The list of AttributeValues.
	List []AttributeValue `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retreived.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

ListAttributeValuesResponse is the response for listing attribute values for a given AttributeType.

func (*ListAttributeValuesResponse) GetList ¶ added in v1.8.0 

func (o *ListAttributeValuesResponse) GetList() []AttributeValue

func (*ListAttributeValuesResponse) GetNextPageToken ¶ added in v1.8.0 

func (o *ListAttributeValuesResponse) GetNextPageToken() *string

type ListPolicyResponse ¶ added in v1.0.3 

type ListPolicyResponse struct {
	// The list of results containing up to X results, where X is the page size defined in the request
	List []Policy `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The ListPolicyResponse message.

func (*ListPolicyResponse) GetList ¶ added in v1.6.1 

func (o *ListPolicyResponse) GetList() []Policy

func (*ListPolicyResponse) GetNextPageToken ¶ added in v1.6.1 

func (o *ListPolicyResponse) GetNextPageToken() *string

type ListRolesResponse ¶ added in v1.0.3 

type ListRolesResponse struct {
	// The list of results containing up to X results, where X is the page size defined in the request.
	List []Role `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retreived.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The ListRolesResponse message contains a list of results and a nextPageToken if applicable.

func (*ListRolesResponse) GetList ¶ added in v1.6.1 

func (o *ListRolesResponse) GetList() []Role

func (*ListRolesResponse) GetNextPageToken ¶ added in v1.6.1 

func (o *ListRolesResponse) GetNextPageToken() *string

type ManagerApproval ¶ added in v1.0.3 

type ManagerApproval struct {
	// Configuration to allow self approval if the target user is their own manager. This may occur if a service account has an identity user and manager specified as the same person.
	AllowSelfApproval *bool `json:"allowSelfApproval,omitempty"`
	// The array of users determined to be the manager during processing time.
	AssignedUserIds []string `json:"assignedUserIds,omitempty"`
	// Configuration to allow a fallback if no manager is found.
	Fallback *bool `json:"fallback,omitempty"`
	// Configuration to specific which users to fallback to if fallback is enabled and no manager is found.
	FallbackUserIds []string `json:"fallbackUserIds,omitempty"`
}

ManagerApproval - The manager approval object provides configuration options for approval when the target of the approval is the manager of the user in the task.

func (*ManagerApproval) GetAllowSelfApproval ¶ added in v1.6.1 

func (o *ManagerApproval) GetAllowSelfApproval() *bool

func (*ManagerApproval) GetAssignedUserIds ¶ added in v1.6.1 

func (o *ManagerApproval) GetAssignedUserIds() []string

func (*ManagerApproval) GetFallback ¶ added in v1.6.1 

func (o *ManagerApproval) GetFallback() *bool

func (*ManagerApproval) GetFallbackUserIds ¶ added in v1.6.1 

func (o *ManagerApproval) GetFallbackUserIds() []string

type ManagerApprovalInput ¶ added in v1.8.0 

type ManagerApprovalInput struct {
	// Configuration to allow self approval if the target user is their own manager. This may occur if a service account has an identity user and manager specified as the same person.
	AllowSelfApproval *bool `json:"allowSelfApproval,omitempty"`
	// Configuration to allow a fallback if no manager is found.
	Fallback *bool `json:"fallback,omitempty"`
	// Configuration to specific which users to fallback to if fallback is enabled and no manager is found.
	FallbackUserIds []string `json:"fallbackUserIds,omitempty"`
}

ManagerApprovalInput - The manager approval object provides configuration options for approval when the target of the approval is the manager of the user in the task.

func (*ManagerApprovalInput) GetAllowSelfApproval ¶ added in v1.21.3 

func (o *ManagerApprovalInput) GetAllowSelfApproval() *bool

func (*ManagerApprovalInput) GetFallback ¶ added in v1.21.3 

func (o *ManagerApprovalInput) GetFallback() *bool

func (*ManagerApprovalInput) GetFallbackUserIds ¶ added in v1.21.3 

func (o *ManagerApprovalInput) GetFallbackUserIds() []string

type ManualProvision ¶ added in v1.0.3 

type ManualProvision struct {
	// This field indicates a text body of instructions for the provisioner to indicate.
	Instructions *string `json:"instructions,omitempty"`
	// An array of users that are required to provision during this step.
	UserIds []string `json:"userIds,omitempty"`
}

ManualProvision - Manual provisioning indicates that a human must intervene for the provisioning of this step.

func (*ManualProvision) GetInstructions ¶ added in v1.6.1 

func (o *ManualProvision) GetInstructions() *string

func (*ManualProvision) GetUserIds ¶ added in v1.6.1 

func (o *ManualProvision) GetUserIds() []string

type Marker ¶ added in v1.15.0 

type Marker struct {
	// The endColumn field.
	EndColumn *int `json:"endColumn,omitempty"`
	// The endLineNumber field.
	EndLineNumber *int `json:"endLineNumber,omitempty"`
	// The message field.
	Message *string `json:"message,omitempty"`
	// The severity field.
	Severity *Severity `json:"severity,omitempty"`
	// The startColumn field.
	StartColumn *int `json:"startColumn,omitempty"`
	// The startLineNumber field.
	StartLineNumber *int `json:"startLineNumber,omitempty"`
}

The Marker message.

func (*Marker) GetEndColumn ¶ added in v1.15.0 

func (o *Marker) GetEndColumn() *int

func (*Marker) GetEndLineNumber ¶ added in v1.15.0 

func (o *Marker) GetEndLineNumber() *int

func (*Marker) GetMessage ¶ added in v1.15.0 

func (o *Marker) GetMessage() *string

func (*Marker) GetSeverity ¶ added in v1.15.0 

func (o *Marker) GetSeverity() *Severity

func (*Marker) GetStartColumn ¶ added in v1.15.0 

func (o *Marker) GetStartColumn() *int

func (*Marker) GetStartLineNumber ¶ added in v1.15.0 

func (o *Marker) GetStartLineNumber() *int

type MembershipType ¶ added in v1.20.0 

type MembershipType string
const (
	MembershipTypeAppEntitlementMembershipTypeUnspecified MembershipType = "APP_ENTITLEMENT_MEMBERSHIP_TYPE_UNSPECIFIED"
	MembershipTypeAppEntitlementMembershipTypeMember      MembershipType = "APP_ENTITLEMENT_MEMBERSHIP_TYPE_MEMBER"
	MembershipTypeAppEntitlementMembershipTypeOwner       MembershipType = "APP_ENTITLEMENT_MEMBERSHIP_TYPE_OWNER"
	MembershipTypeAppEntitlementMembershipTypeExclusion   MembershipType = "APP_ENTITLEMENT_MEMBERSHIP_TYPE_EXCLUSION"
)

func (MembershipType) ToPointer ¶ added in v1.20.0 

func (e MembershipType) ToPointer() *MembershipType

func (*MembershipType) UnmarshalJSON ¶ added in v1.20.0 

func (e *MembershipType) UnmarshalJSON(data []byte) error

type MultiStep ¶ added in v1.18.3 

type MultiStep struct {
	// The array of provision steps to process.
	ProvisionSteps []ProvisionPolicy `json:"provisionSteps,omitempty"`
}

MultiStep indicates that this provision step has multiple steps to process.

func (*MultiStep) GetProvisionSteps ¶ added in v1.18.3 

func (o *MultiStep) GetProvisionSteps() []ProvisionPolicy

type OAuth2AuthorizedAs ¶ added in v1.7.0 

type OAuth2AuthorizedAs struct {
	// authEmail is the email of the user that authorized the connector using OAuth.
	AuthEmail    *string    `json:"authEmail,omitempty"`
	AuthorizedAt *time.Time `json:"authorizedAt,omitempty"`
}

OAuth2AuthorizedAs tracks the user that OAuthed with the connector.

func (*OAuth2AuthorizedAs) GetAuthEmail ¶ added in v1.7.0 

func (o *OAuth2AuthorizedAs) GetAuthEmail() *string

func (*OAuth2AuthorizedAs) GetAuthorizedAt ¶ added in v1.7.0 

func (o *OAuth2AuthorizedAs) GetAuthorizedAt() *time.Time

func (OAuth2AuthorizedAs) MarshalJSON ¶ added in v1.10.1 

func (o OAuth2AuthorizedAs) MarshalJSON() ([]byte, error)

func (*OAuth2AuthorizedAs) UnmarshalJSON ¶ added in v1.10.1 

func (o *OAuth2AuthorizedAs) UnmarshalJSON(data []byte) error

type OAuth2AuthorizedAsInput ¶ added in v1.8.0 

type OAuth2AuthorizedAsInput struct {
}

OAuth2AuthorizedAsInput - OAuth2AuthorizedAs tracks the user that OAuthed with the connector.

type Origin ¶ added in v1.21.4 

type Origin string

Origin - The origin field. 

const (
	OriginTaskOriginUnspecified                 Origin = "TASK_ORIGIN_UNSPECIFIED"
	OriginTaskOriginProfileMembershipAutomation Origin = "TASK_ORIGIN_PROFILE_MEMBERSHIP_AUTOMATION"
	OriginTaskOriginSlack                       Origin = "TASK_ORIGIN_SLACK"
	OriginTaskOriginAPIRequest                  Origin = "TASK_ORIGIN_API_REQUEST"
	OriginTaskOriginJira                        Origin = "TASK_ORIGIN_JIRA"
	OriginTaskOriginCopilot                     Origin = "TASK_ORIGIN_COPILOT"
	OriginTaskOriginWebappRequest               Origin = "TASK_ORIGIN_WEBAPP_REQUEST"
	OriginTaskOriginTimeRevoke                  Origin = "TASK_ORIGIN_TIME_REVOKE"
	OriginTaskOriginNonUsageRevoke              Origin = "TASK_ORIGIN_NON_USAGE_REVOKE"
)

func (Origin) ToPointer ¶ added in v1.21.4 

func (e Origin) ToPointer() *Origin

type Outcome ¶ added in v1.15.0 

type Outcome string

Outcome - The outcome of the certification. 

const (
	OutcomeCertifyOutcomeUnspecified  Outcome = "CERTIFY_OUTCOME_UNSPECIFIED"
	OutcomeCertifyOutcomeCertified    Outcome = "CERTIFY_OUTCOME_CERTIFIED"
	OutcomeCertifyOutcomeDecertified  Outcome = "CERTIFY_OUTCOME_DECERTIFIED"
	OutcomeCertifyOutcomeError        Outcome = "CERTIFY_OUTCOME_ERROR"
	OutcomeCertifyOutcomeCancelled    Outcome = "CERTIFY_OUTCOME_CANCELLED"
	OutcomeCertifyOutcomeWaitTimedOut Outcome = "CERTIFY_OUTCOME_WAIT_TIMED_OUT"
)

func (Outcome) ToPointer ¶ added in v1.15.0 

func (e Outcome) ToPointer() *Outcome

type Payload ¶ added in v1.19.0 

type Payload struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

Payload - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*Payload) GetAdditionalProperties ¶ added in v1.19.0 

func (o *Payload) GetAdditionalProperties() map[string]any

func (*Payload) GetAtType ¶ added in v1.19.0 

func (o *Payload) GetAtType() *string

func (Payload) MarshalJSON ¶ added in v1.19.0 

func (p Payload) MarshalJSON() ([]byte, error)

func (*Payload) UnmarshalJSON ¶ added in v1.19.0 

func (p *Payload) UnmarshalJSON(data []byte) error

type PayloadPolicyApprovalStep ¶ added in v1.19.0 

type PayloadPolicyApprovalStep struct {
	// Contains a task and JSONPATH expressions that describe where in the expanded array related objects are located. This view can be used to display a fully-detailed dashboard of task information.
	TaskView *TaskView `json:"taskView,omitempty"`
	// List of serialized related objects.
	Expanded []PayloadPolicyApprovalStepExpanded `json:"expanded,omitempty"`
}

The PayloadPolicyApprovalStep message.

func (*PayloadPolicyApprovalStep) GetExpanded ¶ added in v1.19.0 

func (o *PayloadPolicyApprovalStep) GetExpanded() []PayloadPolicyApprovalStepExpanded

func (*PayloadPolicyApprovalStep) GetTaskView ¶ added in v1.19.0 

func (o *PayloadPolicyApprovalStep) GetTaskView() *TaskView

type PayloadPolicyApprovalStepExpanded ¶ added in v1.19.0 

type PayloadPolicyApprovalStepExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

PayloadPolicyApprovalStepExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*PayloadPolicyApprovalStepExpanded) GetAdditionalProperties ¶ added in v1.19.0 

func (o *PayloadPolicyApprovalStepExpanded) GetAdditionalProperties() map[string]any

func (*PayloadPolicyApprovalStepExpanded) GetAtType ¶ added in v1.19.0 

func (o *PayloadPolicyApprovalStepExpanded) GetAtType() *string

func (PayloadPolicyApprovalStepExpanded) MarshalJSON ¶ added in v1.19.0 

func (p PayloadPolicyApprovalStepExpanded) MarshalJSON() ([]byte, error)

func (*PayloadPolicyApprovalStepExpanded) UnmarshalJSON ¶ added in v1.19.0 

func (p *PayloadPolicyApprovalStepExpanded) UnmarshalJSON(data []byte) error

type PayloadPolicyPostAction ¶ added in v1.19.0 

type PayloadPolicyPostAction struct {
	// Contains a task and JSONPATH expressions that describe where in the expanded array related objects are located. This view can be used to display a fully-detailed dashboard of task information.
	TaskView *TaskView `json:"taskView,omitempty"`
	// List of serialized related objects.
	Expanded []PayloadPolicyPostActionExpanded `json:"expanded,omitempty"`
}

The PayloadPolicyPostAction message.

func (*PayloadPolicyPostAction) GetExpanded ¶ added in v1.19.0 

func (o *PayloadPolicyPostAction) GetExpanded() []PayloadPolicyPostActionExpanded

func (*PayloadPolicyPostAction) GetTaskView ¶ added in v1.19.0 

func (o *PayloadPolicyPostAction) GetTaskView() *TaskView

type PayloadPolicyPostActionExpanded ¶ added in v1.19.0 

type PayloadPolicyPostActionExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

PayloadPolicyPostActionExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*PayloadPolicyPostActionExpanded) GetAdditionalProperties ¶ added in v1.19.0 

func (o *PayloadPolicyPostActionExpanded) GetAdditionalProperties() map[string]any

func (*PayloadPolicyPostActionExpanded) GetAtType ¶ added in v1.19.0 

func (o *PayloadPolicyPostActionExpanded) GetAtType() *string

func (PayloadPolicyPostActionExpanded) MarshalJSON ¶ added in v1.19.0 

func (p PayloadPolicyPostActionExpanded) MarshalJSON() ([]byte, error)

func (*PayloadPolicyPostActionExpanded) UnmarshalJSON ¶ added in v1.19.0 

func (p *PayloadPolicyPostActionExpanded) UnmarshalJSON(data []byte) error

type PayloadProvisionStep ¶ added in v1.19.0 

type PayloadProvisionStep struct {
	// Contains a task and JSONPATH expressions that describe where in the expanded array related objects are located. This view can be used to display a fully-detailed dashboard of task information.
	TaskView *TaskView `json:"taskView,omitempty"`
	// List of serialized related objects.
	Expanded []PayloadProvisionStepExpanded `json:"expanded,omitempty"`
}

The PayloadProvisionStep message.

func (*PayloadProvisionStep) GetExpanded ¶ added in v1.19.0 

func (o *PayloadProvisionStep) GetExpanded() []PayloadProvisionStepExpanded

func (*PayloadProvisionStep) GetTaskView ¶ added in v1.19.0 

func (o *PayloadProvisionStep) GetTaskView() *TaskView

type PayloadProvisionStepExpanded ¶ added in v1.19.0 

type PayloadProvisionStepExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

PayloadProvisionStepExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*PayloadProvisionStepExpanded) GetAdditionalProperties ¶ added in v1.19.0 

func (o *PayloadProvisionStepExpanded) GetAdditionalProperties() map[string]any

func (*PayloadProvisionStepExpanded) GetAtType ¶ added in v1.19.0 

func (o *PayloadProvisionStepExpanded) GetAtType() *string

func (PayloadProvisionStepExpanded) MarshalJSON ¶ added in v1.19.0 

func (p PayloadProvisionStepExpanded) MarshalJSON() ([]byte, error)

func (*PayloadProvisionStepExpanded) UnmarshalJSON ¶ added in v1.19.0 

func (p *PayloadProvisionStepExpanded) UnmarshalJSON(data []byte) error

type PayloadTest ¶ added in v1.19.0 

type PayloadTest struct {
}

The PayloadTest message.

type PersonalClient ¶ added in v1.1.2 

type PersonalClient struct {
	// If set, only allows the CIDRs in the array to use the credential.
	AllowSourceCidr []string `json:"allowSourceCidr,omitempty"`
	// The clientID of the credential.
	ClientID  *string    `json:"clientId,omitempty"`
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
	// The display name of the personal client credential.
	DisplayName *string    `json:"displayName,omitempty"`
	ExpiresTime *time.Time `json:"expiresTime,omitempty"`
	// The unique ID of the personal client credential.
	ID         *string    `json:"id,omitempty"`
	LastUsedAt *time.Time `json:"lastUsedAt,omitempty"`
	// scoped_roles provides a list of IAM Roles
	//  that this OAuth2 Client's API permissions
	//  are reduced to. The permissions granted to OAuth2 Client
	//  are AND'ed against the owning User's own permissions.
	ScopedRoles []string   `json:"scopedRoles,omitempty"`
	UpdatedAt   *time.Time `json:"updatedAt,omitempty"`
	// The ID of the user that this credential is created for.
	UserID *string `json:"userId,omitempty"`
}

The PersonalClient message contains information about a presonal client credential.

func (*PersonalClient) GetAllowSourceCidr ¶ added in v1.6.1 

func (o *PersonalClient) GetAllowSourceCidr() []string

func (*PersonalClient) GetClientID ¶ added in v1.6.1 

func (o *PersonalClient) GetClientID() *string

func (*PersonalClient) GetCreatedAt ¶ added in v1.6.1 

func (o *PersonalClient) GetCreatedAt() *time.Time

func (*PersonalClient) GetDeletedAt ¶ added in v1.6.1 

func (o *PersonalClient) GetDeletedAt() *time.Time

func (*PersonalClient) GetDisplayName ¶ added in v1.6.1 

func (o *PersonalClient) GetDisplayName() *string

func (*PersonalClient) GetExpiresTime ¶ added in v1.6.1 

func (o *PersonalClient) GetExpiresTime() *time.Time

func (*PersonalClient) GetID ¶ added in v1.6.1 

func (o *PersonalClient) GetID() *string

func (*PersonalClient) GetLastUsedAt ¶ added in v1.6.1 

func (o *PersonalClient) GetLastUsedAt() *time.Time

func (*PersonalClient) GetScopedRoles ¶ added in v1.6.1 

func (o *PersonalClient) GetScopedRoles() []string

func (*PersonalClient) GetUpdatedAt ¶ added in v1.6.1 

func (o *PersonalClient) GetUpdatedAt() *time.Time

func (*PersonalClient) GetUserID ¶ added in v1.6.1 

func (o *PersonalClient) GetUserID() *string

func (PersonalClient) MarshalJSON ¶ added in v1.10.1 

func (p PersonalClient) MarshalJSON() ([]byte, error)

func (*PersonalClient) UnmarshalJSON ¶ added in v1.10.1 

func (p *PersonalClient) UnmarshalJSON(data []byte) error

type PersonalClientInput ¶ added in v1.20.0 

type PersonalClientInput struct {
	// If set, only allows the CIDRs in the array to use the credential.
	AllowSourceCidr []string `json:"allowSourceCidr,omitempty"`
	// The display name of the personal client credential.
	DisplayName *string    `json:"displayName,omitempty"`
	ExpiresTime *time.Time `json:"expiresTime,omitempty"`
	// scoped_roles provides a list of IAM Roles
	//  that this OAuth2 Client's API permissions
	//  are reduced to. The permissions granted to OAuth2 Client
	//  are AND'ed against the owning User's own permissions.
	ScopedRoles []string `json:"scopedRoles,omitempty"`
}

PersonalClientInput - The PersonalClient message contains information about a presonal client credential.

func (*PersonalClientInput) GetAllowSourceCidr ¶ added in v1.20.0 

func (o *PersonalClientInput) GetAllowSourceCidr() []string

func (*PersonalClientInput) GetDisplayName ¶ added in v1.20.0 

func (o *PersonalClientInput) GetDisplayName() *string

func (*PersonalClientInput) GetExpiresTime ¶ added in v1.20.0 

func (o *PersonalClientInput) GetExpiresTime() *time.Time

func (*PersonalClientInput) GetScopedRoles ¶ added in v1.20.0 

func (o *PersonalClientInput) GetScopedRoles() []string

func (PersonalClientInput) MarshalJSON ¶ added in v1.20.0 

func (p PersonalClientInput) MarshalJSON() ([]byte, error)

func (*PersonalClientInput) UnmarshalJSON ¶ added in v1.20.0 

func (p *PersonalClientInput) UnmarshalJSON(data []byte) error

type PersonalClientSearchServiceSearchRequest ¶ added in v1.20.0 

type PersonalClientSearchServiceSearchRequest struct {
	// The pageSize field.
	PageSize *int `json:"pageSize,omitempty"`
	// The pageToken field.
	PageToken *string `json:"pageToken,omitempty"`
	// The query field.
	Query *string `json:"query,omitempty"`
	// The users field.
	Users []UserRef `json:"users,omitempty"`
}

The PersonalClientSearchServiceSearchRequest message.

func (*PersonalClientSearchServiceSearchRequest) GetPageSize ¶ added in v1.20.0 

func (o *PersonalClientSearchServiceSearchRequest) GetPageSize() *int

func (*PersonalClientSearchServiceSearchRequest) GetPageToken ¶ added in v1.20.0 

func (o *PersonalClientSearchServiceSearchRequest) GetPageToken() *string

func (*PersonalClientSearchServiceSearchRequest) GetQuery ¶ added in v1.20.0 

func (o *PersonalClientSearchServiceSearchRequest) GetQuery() *string

func (*PersonalClientSearchServiceSearchRequest) GetUsers ¶ added in v1.20.0 

func (o *PersonalClientSearchServiceSearchRequest) GetUsers() []UserRef

type PersonalClientSearchServiceSearchResponse ¶ added in v1.20.0 

type PersonalClientSearchServiceSearchResponse struct {
	// The list field.
	List []PersonalClient `json:"list,omitempty"`
	// The nextPageToken field.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The PersonalClientSearchServiceSearchResponse message.

func (*PersonalClientSearchServiceSearchResponse) GetList ¶ added in v1.20.0 

func (o *PersonalClientSearchServiceSearchResponse) GetList() []PersonalClient

func (*PersonalClientSearchServiceSearchResponse) GetNextPageToken ¶ added in v1.20.0 

func (o *PersonalClientSearchServiceSearchResponse) GetNextPageToken() *string

type PersonalClientServiceCreateRequest ¶ added in v1.1.2 

type PersonalClientServiceCreateRequest struct {
	// A list of CIDRs to restrict this credential to.
	AllowSourceCidr []string `json:"allowSourceCidr,omitempty"`
	// The display name for the new personal client.
	DisplayName *string `json:"displayName,omitempty"`
	Expires     *string `json:"expires,omitempty"`
	// The list of roles to restrict the credential to.
	ScopedRoles []string `json:"scopedRoles,omitempty"`
}

The PersonalClientServiceCreateRequest message contains the fields for creating a new personal client.

func (*PersonalClientServiceCreateRequest) GetAllowSourceCidr ¶ added in v1.6.1 

func (o *PersonalClientServiceCreateRequest) GetAllowSourceCidr() []string

func (*PersonalClientServiceCreateRequest) GetDisplayName ¶ added in v1.6.1 

func (o *PersonalClientServiceCreateRequest) GetDisplayName() *string

func (*PersonalClientServiceCreateRequest) GetExpires ¶ added in v1.6.1 

func (o *PersonalClientServiceCreateRequest) GetExpires() *string

func (*PersonalClientServiceCreateRequest) GetScopedRoles ¶ added in v1.6.1 

func (o *PersonalClientServiceCreateRequest) GetScopedRoles() []string

type PersonalClientServiceCreateResponse ¶ added in v1.1.2 

type PersonalClientServiceCreateResponse struct {
	// The PersonalClient message contains information about a presonal client credential.
	PersonalClient *PersonalClient `json:"client,omitempty"`
	// The client secret that corresponds to the personal client. Make sure to save this, because it cannot be returned or queried again.
	ClientSecret *string `json:"clientSecret,omitempty"`
}

The PersonalClientServiceCreateResponse message contains the created personal client and client secret.

func (*PersonalClientServiceCreateResponse) GetClientSecret ¶ added in v1.6.1 

func (o *PersonalClientServiceCreateResponse) GetClientSecret() *string

func (*PersonalClientServiceCreateResponse) GetPersonalClient ¶ added in v1.6.1 

func (o *PersonalClientServiceCreateResponse) GetPersonalClient() *PersonalClient

type PersonalClientServiceDeleteRequest ¶ added in v1.20.0 

type PersonalClientServiceDeleteRequest struct {
}

The PersonalClientServiceDeleteRequest message.

type PersonalClientServiceDeleteResponse ¶ added in v1.20.0 

type PersonalClientServiceDeleteResponse struct {
}

The PersonalClientServiceDeleteResponse message.

type PersonalClientServiceGetResponse ¶ added in v1.20.0 

type PersonalClientServiceGetResponse struct {
	// The PersonalClient message contains information about a presonal client credential.
	PersonalClient *PersonalClient `json:"client,omitempty"`
}

The PersonalClientServiceGetResponse message.

func (*PersonalClientServiceGetResponse) GetPersonalClient ¶ added in v1.20.0 

func (o *PersonalClientServiceGetResponse) GetPersonalClient() *PersonalClient

type PersonalClientServiceListResponse ¶ added in v1.20.0 

type PersonalClientServiceListResponse struct {
	// The list field.
	List []PersonalClient `json:"list,omitempty"`
	// The nextPageToken field.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The PersonalClientServiceListResponse message.

func (*PersonalClientServiceListResponse) GetList ¶ added in v1.20.0 

func (o *PersonalClientServiceListResponse) GetList() []PersonalClient

func (*PersonalClientServiceListResponse) GetNextPageToken ¶ added in v1.20.0 

func (o *PersonalClientServiceListResponse) GetNextPageToken() *string

type PersonalClientServiceUpdateRequest ¶ added in v1.20.0 

type PersonalClientServiceUpdateRequest struct {
	// The PersonalClient message contains information about a presonal client credential.
	PersonalClient *PersonalClientInput `json:"client,omitempty"`
	UpdateMask     *string              `json:"updateMask,omitempty"`
}

The PersonalClientServiceUpdateRequest message.

func (*PersonalClientServiceUpdateRequest) GetPersonalClient ¶ added in v1.20.0 

func (o *PersonalClientServiceUpdateRequest) GetPersonalClient() *PersonalClientInput

func (*PersonalClientServiceUpdateRequest) GetUpdateMask ¶ added in v1.20.0 

func (o *PersonalClientServiceUpdateRequest) GetUpdateMask() *string

type PersonalClientServiceUpdateResponse ¶ added in v1.20.0 

type PersonalClientServiceUpdateResponse struct {
	// The PersonalClient message contains information about a presonal client credential.
	PersonalClient *PersonalClient `json:"client,omitempty"`
}

The PersonalClientServiceUpdateResponse message.

func (*PersonalClientServiceUpdateResponse) GetPersonalClient ¶ added in v1.20.0 

func (o *PersonalClientServiceUpdateResponse) GetPersonalClient() *PersonalClient

type Policy ¶ added in v1.0.3 

type Policy struct {
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
	// The description of the Policy.
	Description *string `json:"description,omitempty"`
	// The display name of the Policy.
	DisplayName *string `json:"displayName,omitempty"`
	// The ID of the Policy.
	ID *string `json:"id,omitempty"`
	// A map of string(policy type) to steps in a policy. This structure is leftover from a previous design, and should only ever have one key->value set.
	PolicySteps map[string]PolicySteps `json:"policySteps,omitempty"`
	// Indicates the type of this policy. Can also be used to get the value from policySteps.
	PolicyType *PolicyPolicyType `json:"policyType,omitempty"`
	// An array of actions (ordered) to take place after a policy completes processing.
	PostActions []PolicyPostActions `json:"postActions,omitempty"`
	// A policy configuration option that allows for reassinging tasks to delgated users. This level of delegation refers to the individual delegates users set on their account.
	ReassignTasksToDelegates *bool `json:"reassignTasksToDelegates,omitempty"`
	// The rules field.
	Rules []Rule `json:"rules,omitempty"`
	// Whether this policy is a builtin system policy. Builtin system policies cannot be edited.
	SystemBuiltin *bool      `json:"systemBuiltin,omitempty"`
	UpdatedAt     *time.Time `json:"updatedAt,omitempty"`
}

Policy - A policy describes the behavior of the ConductorOne system when processing a task. You can describe the type, approvers, fallback behavior, and escalation processes.

func (*Policy) GetCreatedAt ¶ added in v1.6.1 

func (o *Policy) GetCreatedAt() *time.Time

func (*Policy) GetDeletedAt ¶ added in v1.6.1 

func (o *Policy) GetDeletedAt() *time.Time

func (*Policy) GetDescription ¶ added in v1.6.1 

func (o *Policy) GetDescription() *string

func (*Policy) GetDisplayName ¶ added in v1.6.1 

func (o *Policy) GetDisplayName() *string

func (*Policy) GetID ¶ added in v1.6.1 

func (o *Policy) GetID() *string

func (*Policy) GetPolicySteps ¶ added in v1.6.1 

func (o *Policy) GetPolicySteps() map[string]PolicySteps

func (*Policy) GetPolicyType ¶ added in v1.6.1 

func (o *Policy) GetPolicyType() *PolicyPolicyType

func (*Policy) GetPostActions ¶ added in v1.6.1 

func (o *Policy) GetPostActions() []PolicyPostActions

func (*Policy) GetReassignTasksToDelegates ¶ added in v1.6.1 

func (o *Policy) GetReassignTasksToDelegates() *bool

func (*Policy) GetRules ¶ added in v1.9.0 

func (o *Policy) GetRules() []Rule

func (*Policy) GetSystemBuiltin ¶ added in v1.6.1 

func (o *Policy) GetSystemBuiltin() *bool

func (*Policy) GetUpdatedAt ¶ added in v1.6.1 

func (o *Policy) GetUpdatedAt() *time.Time

func (Policy) MarshalJSON ¶ added in v1.10.1 

func (p Policy) MarshalJSON() ([]byte, error)

func (*Policy) UnmarshalJSON ¶ added in v1.10.1 

func (p *Policy) UnmarshalJSON(data []byte) error

type PolicyInput ¶ added in v1.7.0 

type PolicyInput struct {
	// The description of the Policy.
	Description *string `json:"description,omitempty"`
	// The display name of the Policy.
	DisplayName *string `json:"displayName,omitempty"`
	// A map of string(policy type) to steps in a policy. This structure is leftover from a previous design, and should only ever have one key->value set.
	PolicySteps map[string]PolicyStepsInput `json:"policySteps,omitempty"`
	// Indicates the type of this policy. Can also be used to get the value from policySteps.
	PolicyType *PolicyPolicyType `json:"policyType,omitempty"`
	// An array of actions (ordered) to take place after a policy completes processing.
	PostActions []PolicyPostActions `json:"postActions,omitempty"`
	// A policy configuration option that allows for reassinging tasks to delgated users. This level of delegation refers to the individual delegates users set on their account.
	ReassignTasksToDelegates *bool `json:"reassignTasksToDelegates,omitempty"`
	// The rules field.
	Rules []Rule `json:"rules,omitempty"`
}

PolicyInput - A policy describes the behavior of the ConductorOne system when processing a task. You can describe the type, approvers, fallback behavior, and escalation processes.

func (*PolicyInput) GetDescription ¶ added in v1.7.0 

func (o *PolicyInput) GetDescription() *string

func (*PolicyInput) GetDisplayName ¶ added in v1.7.0 

func (o *PolicyInput) GetDisplayName() *string

func (*PolicyInput) GetPolicySteps ¶ added in v1.7.0 

func (o *PolicyInput) GetPolicySteps() map[string]PolicyStepsInput

func (*PolicyInput) GetPolicyType ¶ added in v1.7.0 

func (o *PolicyInput) GetPolicyType() *PolicyPolicyType

func (*PolicyInput) GetPostActions ¶ added in v1.7.0 

func (o *PolicyInput) GetPostActions() []PolicyPostActions

func (*PolicyInput) GetReassignTasksToDelegates ¶ added in v1.7.0 

func (o *PolicyInput) GetReassignTasksToDelegates() *bool

func (*PolicyInput) GetRules ¶ added in v1.9.0 

func (o *PolicyInput) GetRules() []Rule

type PolicyInstance ¶ added in v1.0.3 

type PolicyInstance struct {
	// A policy describes the behavior of the ConductorOne system when processing a task. You can describe the type, approvers, fallback behavior, and escalation processes.
	Policy *Policy `json:"policy,omitempty"`
	// The policy step instance includes a reference to an instance of a policy step that tracks state and has a unique ID.
	//
	// This message contains a oneof named instance. Only a single field of the following list may be set at a time:
	//   - approval
	//   - provision
	//   - accept
	//   - reject
	//   - wait
	//
	PolicyStepInstance *PolicyStepInstance `json:"current,omitempty"`
	// An array of steps that were previously processed by the ticket with their outcomes set, in order.
	History []PolicyStepInstance `json:"history,omitempty"`
	// An array of steps that will be processed by the ticket, in order.
	Next []PolicyStep `json:"next,omitempty"`
}

PolicyInstance - A policy instance is an object that contains a reference to the policy it was created from, the currently executing step, the next steps, and the history of previously completed steps.

func (*PolicyInstance) GetHistory ¶ added in v1.6.1 

func (o *PolicyInstance) GetHistory() []PolicyStepInstance

func (*PolicyInstance) GetNext ¶ added in v1.6.1 

func (o *PolicyInstance) GetNext() []PolicyStep

func (*PolicyInstance) GetPolicy ¶ added in v1.6.1 

func (o *PolicyInstance) GetPolicy() *Policy

func (*PolicyInstance) GetPolicyStepInstance ¶ added in v1.6.1 

func (o *PolicyInstance) GetPolicyStepInstance() *PolicyStepInstance

type PolicyPolicyType ¶ added in v1.0.3 

type PolicyPolicyType string

PolicyPolicyType - Indicates the type of this policy. Can also be used to get the value from policySteps. 

const (
	PolicyPolicyTypePolicyTypeUnspecified   PolicyPolicyType = "POLICY_TYPE_UNSPECIFIED"
	PolicyPolicyTypePolicyTypeGrant         PolicyPolicyType = "POLICY_TYPE_GRANT"
	PolicyPolicyTypePolicyTypeRevoke        PolicyPolicyType = "POLICY_TYPE_REVOKE"
	PolicyPolicyTypePolicyTypeCertify       PolicyPolicyType = "POLICY_TYPE_CERTIFY"
	PolicyPolicyTypePolicyTypeAccessRequest PolicyPolicyType = "POLICY_TYPE_ACCESS_REQUEST"
	PolicyPolicyTypePolicyTypeProvision     PolicyPolicyType = "POLICY_TYPE_PROVISION"
)

func (PolicyPolicyType) ToPointer ¶ added in v1.0.3 

func (e PolicyPolicyType) ToPointer() *PolicyPolicyType

type PolicyPostActions ¶ added in v1.0.3 

type PolicyPostActions struct {
	// ONLY valid when used in a CERTIFY Ticket Type:
	//  Causes any deprovision or change in a grant to be applied when Certify Ticket is closed.
	// This field is part of the `action` oneof.
	// See the documentation for `c1.api.policy.v1.PolicyPostActions` for more details.
	CertifyRemediateImmediately *bool `json:"certifyRemediateImmediately,omitempty"`
}

PolicyPostActions - These are actions to happen after a policy is complete.

This message contains a oneof named action. Only a single field of the following list may be set at a time:

  • certifyRemediateImmediately

func (*PolicyPostActions) GetCertifyRemediateImmediately ¶ added in v1.6.1 

func (o *PolicyPostActions) GetCertifyRemediateImmediately() *bool

type PolicyRef ¶ added in v1.8.0 

type PolicyRef struct {
	// The id field.
	ID *string `json:"id,omitempty"`
}

The PolicyRef message.

func (*PolicyRef) GetID ¶ added in v1.8.0 

func (o *PolicyRef) GetID() *string

type PolicyStep ¶ added in v1.0.3 

type PolicyStep struct {
	// This policy step indicates that a ticket should have an approved outcome. This is a terminal approval state and is used to explicitly define the end of approval steps.
	Accept *Accept `json:"accept,omitempty"`
	// The Approval message.
	//
	// This message contains a oneof named typ. Only a single field of the following list may be set at a time:
	//   - users
	//   - manager
	//   - appOwners
	//   - group
	//   - self
	//   - entitlementOwners
	//   - expression
	//   - webhook
	//   - resourceOwners
	//
	Approval *Approval `json:"approval,omitempty"`
	// The provision step references a provision policy for this step.
	Provision *Provision `json:"provision,omitempty"`
	// This policy step indicates that a ticket should have a denied outcome. This is a terminal approval state and is used to explicitly define the end of approval steps.
	Reject *Reject `json:"reject,omitempty"`
	// Define a Wait step for a policy to wait on a condition to be met.
	//
	// This message contains a oneof named until. Only a single field of the following list may be set at a time:
	//   - condition
	//
	Wait *Wait `json:"wait,omitempty"`
}

The PolicyStep message.

This message contains a oneof named step. Only a single field of the following list may be set at a time:

  • approval
  • provision
  • accept
  • reject
  • wait

func (*PolicyStep) GetAccept ¶ added in v1.10.1 

func (o *PolicyStep) GetAccept() *Accept

func (*PolicyStep) GetApproval ¶ added in v1.6.1 

func (o *PolicyStep) GetApproval() *Approval

func (*PolicyStep) GetProvision ¶ added in v1.6.1 

func (o *PolicyStep) GetProvision() *Provision

func (*PolicyStep) GetReject ¶ added in v1.10.1 

func (o *PolicyStep) GetReject() *Reject

func (*PolicyStep) GetWait ¶ added in v1.18.3 

func (o *PolicyStep) GetWait() *Wait

type PolicyStepInput ¶ added in v1.7.0 

type PolicyStepInput struct {
	// This policy step indicates that a ticket should have an approved outcome. This is a terminal approval state and is used to explicitly define the end of approval steps.
	Accept *Accept `json:"accept,omitempty"`
	// The Approval message.
	//
	// This message contains a oneof named typ. Only a single field of the following list may be set at a time:
	//   - users
	//   - manager
	//   - appOwners
	//   - group
	//   - self
	//   - entitlementOwners
	//   - expression
	//   - webhook
	//   - resourceOwners
	//
	Approval *ApprovalInput `json:"approval,omitempty"`
	// The provision step references a provision policy for this step.
	Provision *Provision `json:"provision,omitempty"`
	// This policy step indicates that a ticket should have a denied outcome. This is a terminal approval state and is used to explicitly define the end of approval steps.
	Reject *Reject `json:"reject,omitempty"`
	// Define a Wait step for a policy to wait on a condition to be met.
	//
	// This message contains a oneof named until. Only a single field of the following list may be set at a time:
	//   - condition
	//
	Wait *Wait `json:"wait,omitempty"`
}

PolicyStepInput - The PolicyStep message.

This message contains a oneof named step. Only a single field of the following list may be set at a time:

  • approval
  • provision
  • accept
  • reject
  • wait

func (*PolicyStepInput) GetAccept ¶ added in v1.10.1 

func (o *PolicyStepInput) GetAccept() *Accept

func (*PolicyStepInput) GetApproval ¶ added in v1.7.0 

func (o *PolicyStepInput) GetApproval() *ApprovalInput

func (*PolicyStepInput) GetProvision ¶ added in v1.7.0 

func (o *PolicyStepInput) GetProvision() *Provision

func (*PolicyStepInput) GetReject ¶ added in v1.10.1 

func (o *PolicyStepInput) GetReject() *Reject

func (*PolicyStepInput) GetWait ¶ added in v1.21.3 

func (o *PolicyStepInput) GetWait() *Wait

type PolicyStepInstance ¶ added in v1.0.3 

type PolicyStepInstance struct {
	// This policy step indicates that a ticket should have an approved outcome. This is a terminal approval state and is used to explicitly define the end of approval steps.
	//  The instance is just a marker for it being copied into an active policy.
	AcceptInstance *AcceptInstance `json:"accept,omitempty"`
	// The approval instance object describes the way a policy step should be approved as well as its outcomes and state.
	//
	// This message contains a oneof named outcome. Only a single field of the following list may be set at a time:
	//   - approved
	//   - denied
	//   - reassigned
	//   - restarted
	//   - reassignedByError
	//
	ApprovalInstance *ApprovalInstance `json:"approval,omitempty"`
	// A provision instance describes the specific configuration of an executing provision policy step including actions taken and notification id.
	//
	// This message contains a oneof named outcome. Only a single field of the following list may be set at a time:
	//   - completed
	//   - cancelled
	//   - errored
	//   - reassignedByError
	//
	ProvisionInstance *ProvisionInstance `json:"provision,omitempty"`
	// This policy step indicates that a ticket should have a denied outcome. This is a terminal approval state and is used to explicitly define the end of approval steps.
	//  The instance is just a marker for it being copied into an active policy.
	RejectInstance *RejectInstance `json:"reject,omitempty"`
	// Used by the policy engine to describe an instantiated wait step.
	//
	// This message contains a oneof named until. Only a single field of the following list may be set at a time:
	//   - condition
	//
	//
	// This message contains a oneof named outcome. Only a single field of the following list may be set at a time:
	//   - succeeded
	//   - timedOut
	//
	WaitInstance *WaitInstance `json:"wait,omitempty"`
	// The ID of the PolicyStepInstance. This is required by many action submission endpoints to indicate what step you're approving.
	ID *string `json:"id,omitempty"`
	// The policy generation id refers to the version of the policy that this step was created from.
	PolicyGenerationID *string `json:"policyGenerationId,omitempty"`
	// The state of the step, which is either active or done.
	State *PolicyStepInstanceState `json:"state,omitempty"`
}

PolicyStepInstance - The policy step instance includes a reference to an instance of a policy step that tracks state and has a unique ID.

This message contains a oneof named instance. Only a single field of the following list may be set at a time:

  • approval
  • provision
  • accept
  • reject
  • wait

func (*PolicyStepInstance) GetAcceptInstance ¶ added in v1.10.1 

func (o *PolicyStepInstance) GetAcceptInstance() *AcceptInstance

func (*PolicyStepInstance) GetApprovalInstance ¶ added in v1.6.1 

func (o *PolicyStepInstance) GetApprovalInstance() *ApprovalInstance

func (*PolicyStepInstance) GetID ¶ added in v1.6.1 

func (o *PolicyStepInstance) GetID() *string

func (*PolicyStepInstance) GetPolicyGenerationID ¶ added in v1.8.0 

func (o *PolicyStepInstance) GetPolicyGenerationID() *string

func (*PolicyStepInstance) GetProvisionInstance ¶ added in v1.6.1 

func (o *PolicyStepInstance) GetProvisionInstance() *ProvisionInstance

func (*PolicyStepInstance) GetRejectInstance ¶ added in v1.10.1 

func (o *PolicyStepInstance) GetRejectInstance() *RejectInstance

func (*PolicyStepInstance) GetState ¶ added in v1.6.1 

func (o *PolicyStepInstance) GetState() *PolicyStepInstanceState

func (*PolicyStepInstance) GetWaitInstance ¶ added in v1.18.3 

func (o *PolicyStepInstance) GetWaitInstance() *WaitInstance

type PolicyStepInstanceState ¶ added in v1.0.3 

type PolicyStepInstanceState string

PolicyStepInstanceState - The state of the step, which is either active or done. 

const (
	PolicyStepInstanceStatePolicyStepStateUnspecified PolicyStepInstanceState = "POLICY_STEP_STATE_UNSPECIFIED"
	PolicyStepInstanceStatePolicyStepStateActive      PolicyStepInstanceState = "POLICY_STEP_STATE_ACTIVE"
	PolicyStepInstanceStatePolicyStepStateDone        PolicyStepInstanceState = "POLICY_STEP_STATE_DONE"
)

func (PolicyStepInstanceState) ToPointer ¶ added in v1.0.3 

func (e PolicyStepInstanceState) ToPointer() *PolicyStepInstanceState

type PolicySteps ¶ added in v1.0.3 

type PolicySteps struct {
	// An array of policy steps indicating the processing flow of a policy. These steps are oneOfs, and only one property may be set for each array index at a time.
	Steps []PolicyStep `json:"steps,omitempty"`
}

The PolicySteps message.

func (*PolicySteps) GetSteps ¶ added in v1.6.1 

func (o *PolicySteps) GetSteps() []PolicyStep

type PolicyStepsInput ¶ added in v1.7.0 

type PolicyStepsInput struct {
	// An array of policy steps indicating the processing flow of a policy. These steps are oneOfs, and only one property may be set for each array index at a time.
	Steps []PolicyStepInput `json:"steps,omitempty"`
}

PolicyStepsInput - The PolicySteps message.

func (*PolicyStepsInput) GetSteps ¶ added in v1.7.0 

func (o *PolicyStepsInput) GetSteps() []PolicyStepInput

type PolicyType ¶ added in v1.15.0 

type PolicyType string

PolicyType - The enum of the policy type. 

const (
	PolicyTypePolicyTypeUnspecified   PolicyType = "POLICY_TYPE_UNSPECIFIED"
	PolicyTypePolicyTypeGrant         PolicyType = "POLICY_TYPE_GRANT"
	PolicyTypePolicyTypeRevoke        PolicyType = "POLICY_TYPE_REVOKE"
	PolicyTypePolicyTypeCertify       PolicyType = "POLICY_TYPE_CERTIFY"
	PolicyTypePolicyTypeAccessRequest PolicyType = "POLICY_TYPE_ACCESS_REQUEST"
	PolicyTypePolicyTypeProvision     PolicyType = "POLICY_TYPE_PROVISION"
)

func (PolicyType) ToPointer ¶ added in v1.15.0 

func (e PolicyType) ToPointer() *PolicyType

type PolicyTypes ¶ added in v1.15.0 

type PolicyTypes string
const (
	PolicyTypesPolicyTypeUnspecified   PolicyTypes = "POLICY_TYPE_UNSPECIFIED"
	PolicyTypesPolicyTypeGrant         PolicyTypes = "POLICY_TYPE_GRANT"
	PolicyTypesPolicyTypeRevoke        PolicyTypes = "POLICY_TYPE_REVOKE"
	PolicyTypesPolicyTypeCertify       PolicyTypes = "POLICY_TYPE_CERTIFY"
	PolicyTypesPolicyTypeAccessRequest PolicyTypes = "POLICY_TYPE_ACCESS_REQUEST"
	PolicyTypesPolicyTypeProvision     PolicyTypes = "POLICY_TYPE_PROVISION"
)

func (PolicyTypes) ToPointer ¶ added in v1.15.0 

func (e PolicyTypes) ToPointer() *PolicyTypes

func (*PolicyTypes) UnmarshalJSON ¶ added in v1.15.0 

func (e *PolicyTypes) UnmarshalJSON(data []byte) error

type Processing ¶ added in v1.15.0 

type Processing string

Processing - The processing state of a task as defined by the `processing_enum` 

const (
	ProcessingTaskProcessingTypeUnspecified Processing = "TASK_PROCESSING_TYPE_UNSPECIFIED"
	ProcessingTaskProcessingTypeProcessing  Processing = "TASK_PROCESSING_TYPE_PROCESSING"
	ProcessingTaskProcessingTypeWaiting     Processing = "TASK_PROCESSING_TYPE_WAITING"
	ProcessingTaskProcessingTypeDone        Processing = "TASK_PROCESSING_TYPE_DONE"
)

func (Processing) ToPointer ¶ added in v1.15.0 

func (e Processing) ToPointer() *Processing

type Provision ¶ added in v1.0.3 

type Provision struct {
	// ProvisionPolicy is a oneOf that indicates how a provision step should be processed.
	//
	// This message contains a oneof named typ. Only a single field of the following list may be set at a time:
	//   - connector
	//   - manual
	//   - delegated
	//   - webhook
	//   - multiStep
	//   - externalTicket
	//
	ProvisionPolicy *ProvisionPolicyInput `json:"provisionPolicy,omitempty"`
	// ProvisionTarget indicates the specific app, app entitlement, and if known, the app user and grant duration of this provision step
	ProvisionTarget *ProvisionTarget `json:"provisionTarget,omitempty"`
	// A field indicating whether this step is assigned.
	Assigned *bool `json:"assigned,omitempty"`
}

Provision - The provision step references a provision policy for this step.

func (*Provision) GetAssigned ¶ added in v1.6.1 

func (o *Provision) GetAssigned() *bool

func (*Provision) GetProvisionPolicy ¶ added in v1.6.1 

func (o *Provision) GetProvisionPolicy() *ProvisionPolicyInput

func (*Provision) GetProvisionTarget ¶ added in v1.8.0 

func (o *Provision) GetProvisionTarget() *ProvisionTarget

type ProvisionInstance ¶ added in v1.0.3 

type ProvisionInstance struct {
	// The outcome of a provision instance that is cancelled.
	CancelledAction *CancelledAction `json:"cancelled,omitempty"`
	// The outcome of a provision instance that has been completed succesfully.
	CompletedAction *CompletedAction `json:"completed,omitempty"`
	// The outcome of a provision instance that has errored.
	ErroredAction *ErroredAction `json:"errored,omitempty"`
	// The provision step references a provision policy for this step.
	Provision *Provision `json:"provision,omitempty"`
	// The ReassignedByErrorAction object describes the outcome of a policy step that has been reassigned because it had an error provisioning.
	ReassignedByErrorAction *ReassignedByErrorAction `json:"reassignedByError,omitempty"`
	// This indicates the notification id for this step.
	NotificationID *string `json:"notificationId,omitempty"`
	// This property indicates the current state of this step.
	State *ProvisionInstanceState `json:"state,omitempty"`
}

ProvisionInstance - A provision instance describes the specific configuration of an executing provision policy step including actions taken and notification id.

This message contains a oneof named outcome. Only a single field of the following list may be set at a time:

  • completed
  • cancelled
  • errored
  • reassignedByError

func (*ProvisionInstance) GetCancelledAction ¶ added in v1.6.1 

func (o *ProvisionInstance) GetCancelledAction() *CancelledAction

func (*ProvisionInstance) GetCompletedAction ¶ added in v1.6.1 

func (o *ProvisionInstance) GetCompletedAction() *CompletedAction

func (*ProvisionInstance) GetErroredAction ¶ added in v1.6.1 

func (o *ProvisionInstance) GetErroredAction() *ErroredAction

func (*ProvisionInstance) GetNotificationID ¶ added in v1.6.1 

func (o *ProvisionInstance) GetNotificationID() *string

func (*ProvisionInstance) GetProvision ¶ added in v1.6.1 

func (o *ProvisionInstance) GetProvision() *Provision

func (*ProvisionInstance) GetReassignedByErrorAction ¶ added in v1.6.1 

func (o *ProvisionInstance) GetReassignedByErrorAction() *ReassignedByErrorAction

func (*ProvisionInstance) GetState ¶ added in v1.6.1 

func (o *ProvisionInstance) GetState() *ProvisionInstanceState

type ProvisionInstanceState ¶ added in v1.0.3 

type ProvisionInstanceState string

ProvisionInstanceState - This property indicates the current state of this step. 

const (
	ProvisionInstanceStateProvisionInstanceStateUnspecified                     ProvisionInstanceState = "PROVISION_INSTANCE_STATE_UNSPECIFIED"
	ProvisionInstanceStateProvisionInstanceStateInit                            ProvisionInstanceState = "PROVISION_INSTANCE_STATE_INIT"
	ProvisionInstanceStateProvisionInstanceStateCreateConnectorActionsForTarget ProvisionInstanceState = "PROVISION_INSTANCE_STATE_CREATE_CONNECTOR_ACTIONS_FOR_TARGET"
	ProvisionInstanceStateProvisionInstanceStateSendingNotifications            ProvisionInstanceState = "PROVISION_INSTANCE_STATE_SENDING_NOTIFICATIONS"
	ProvisionInstanceStateProvisionInstanceStateWaiting                         ProvisionInstanceState = "PROVISION_INSTANCE_STATE_WAITING"
	ProvisionInstanceStateProvisionInstanceStateWebhook                         ProvisionInstanceState = "PROVISION_INSTANCE_STATE_WEBHOOK"
	ProvisionInstanceStateProvisionInstanceStateWebhookWaiting                  ProvisionInstanceState = "PROVISION_INSTANCE_STATE_WEBHOOK_WAITING"
	ProvisionInstanceStateProvisionInstanceStateExternalTicket                  ProvisionInstanceState = "PROVISION_INSTANCE_STATE_EXTERNAL_TICKET"
	ProvisionInstanceStateProvisionInstanceStateExternalTicketWaiting           ProvisionInstanceState = "PROVISION_INSTANCE_STATE_EXTERNAL_TICKET_WAITING"
	ProvisionInstanceStateProvisionInstanceStateDone                            ProvisionInstanceState = "PROVISION_INSTANCE_STATE_DONE"
)

func (ProvisionInstanceState) ToPointer ¶ added in v1.0.3 

func (e ProvisionInstanceState) ToPointer() *ProvisionInstanceState

type ProvisionPolicy ¶ added in v1.0.3 

type ProvisionPolicy struct {
	// Indicates that a connector should perform the provisioning. This object has no fields.
	ConnectorProvision *ConnectorProvision `json:"connector,omitempty"`
	// This provision step indicates that we should delegate provisioning to the configuration of another app entitlement. This app entitlement does not have to be one from the same app, but MUST be configured as a proxy binding leading into this entitlement.
	DelegatedProvision *DelegatedProvision `json:"delegated,omitempty"`
	// This provision step indicates that we should check an external ticket to provision this entitlement
	ExternalTicketProvision *ExternalTicketProvision `json:"externalTicket,omitempty"`
	// Manual provisioning indicates that a human must intervene for the provisioning of this step.
	ManualProvision *ManualProvision `json:"manual,omitempty"`
	// MultiStep indicates that this provision step has multiple steps to process.
	MultiStep *MultiStep `json:"multiStep,omitempty"`
	// This provision step indicates that a webhook should be called to provision this entitlement.
	WebhookProvision *WebhookProvision `json:"webhook,omitempty"`
}

ProvisionPolicy is a oneOf that indicates how a provision step should be processed.

This message contains a oneof named typ. Only a single field of the following list may be set at a time:

  • connector
  • manual
  • delegated
  • webhook
  • multiStep
  • externalTicket

func (*ProvisionPolicy) GetConnectorProvision ¶ added in v1.6.1 

func (o *ProvisionPolicy) GetConnectorProvision() *ConnectorProvision

func (*ProvisionPolicy) GetDelegatedProvision ¶ added in v1.6.1 

func (o *ProvisionPolicy) GetDelegatedProvision() *DelegatedProvision

func (*ProvisionPolicy) GetExternalTicketProvision ¶ added in v1.18.3 

func (o *ProvisionPolicy) GetExternalTicketProvision() *ExternalTicketProvision

func (*ProvisionPolicy) GetManualProvision ¶ added in v1.6.1 

func (o *ProvisionPolicy) GetManualProvision() *ManualProvision

func (*ProvisionPolicy) GetMultiStep ¶ added in v1.18.3 

func (o *ProvisionPolicy) GetMultiStep() *MultiStep

func (*ProvisionPolicy) GetWebhookProvision ¶ added in v1.18.3 

func (o *ProvisionPolicy) GetWebhookProvision() *WebhookProvision

type ProvisionPolicyInput ¶ added in v1.20.0 

type ProvisionPolicyInput struct {
	// Indicates that a connector should perform the provisioning. This object has no fields.
	ConnectorProvision *ConnectorProvision `json:"connector,omitempty"`
	// This provision step indicates that we should delegate provisioning to the configuration of another app entitlement. This app entitlement does not have to be one from the same app, but MUST be configured as a proxy binding leading into this entitlement.
	DelegatedProvision *DelegatedProvision `json:"delegated,omitempty"`
	// This provision step indicates that we should check an external ticket to provision this entitlement
	ExternalTicketProvision *ExternalTicketProvision `json:"externalTicket,omitempty"`
	// Manual provisioning indicates that a human must intervene for the provisioning of this step.
	ManualProvision *ManualProvision `json:"manual,omitempty"`
	// MultiStep indicates that this provision step has multiple steps to process.
	MultiStep *MultiStep `json:"multiStep,omitempty"`
	// This provision step indicates that a webhook should be called to provision this entitlement.
	WebhookProvision *WebhookProvision `json:"webhook,omitempty"`
}

ProvisionPolicyInput - ProvisionPolicy is a oneOf that indicates how a provision step should be processed.

This message contains a oneof named typ. Only a single field of the following list may be set at a time:

  • connector
  • manual
  • delegated
  • webhook
  • multiStep
  • externalTicket

func (*ProvisionPolicyInput) GetConnectorProvision ¶ added in v1.20.0 

func (o *ProvisionPolicyInput) GetConnectorProvision() *ConnectorProvision

func (*ProvisionPolicyInput) GetDelegatedProvision ¶ added in v1.20.0 

func (o *ProvisionPolicyInput) GetDelegatedProvision() *DelegatedProvision

func (*ProvisionPolicyInput) GetExternalTicketProvision ¶ added in v1.20.0 

func (o *ProvisionPolicyInput) GetExternalTicketProvision() *ExternalTicketProvision

func (*ProvisionPolicyInput) GetManualProvision ¶ added in v1.20.0 

func (o *ProvisionPolicyInput) GetManualProvision() *ManualProvision

func (*ProvisionPolicyInput) GetMultiStep ¶ added in v1.20.0 

func (o *ProvisionPolicyInput) GetMultiStep() *MultiStep

func (*ProvisionPolicyInput) GetWebhookProvision ¶ added in v1.20.0 

func (o *ProvisionPolicyInput) GetWebhookProvision() *WebhookProvision

type ProvisionTarget ¶ added in v1.8.0 

type ProvisionTarget struct {
	// The app entitlement that should be provisioned.
	AppEntitlementID *string `json:"appEntitlementId,omitempty"`
	// The app in which the entitlement should be provisioned
	AppID *string `json:"appId,omitempty"`
	// The app user that should be provisioned. May be unset if the app user is unknown
	AppUserID     *string `json:"appUserId,omitempty"`
	GrantDuration *string `json:"grantDuration,omitempty"`
}

ProvisionTarget indicates the specific app, app entitlement, and if known, the app user and grant duration of this provision step

func (*ProvisionTarget) GetAppEntitlementID ¶ added in v1.8.0 

func (o *ProvisionTarget) GetAppEntitlementID() *string

func (*ProvisionTarget) GetAppID ¶ added in v1.8.0 

func (o *ProvisionTarget) GetAppID() *string

func (*ProvisionTarget) GetAppUserID ¶ added in v1.8.0 

func (o *ProvisionTarget) GetAppUserID() *string

func (*ProvisionTarget) GetGrantDuration ¶ added in v1.8.0 

func (o *ProvisionTarget) GetGrantDuration() *string

type Purpose ¶ added in v1.21.4 

type Purpose string

Purpose - The purpose field. 

const (
	PurposeAppEntitlementPurposeValueUnspecified Purpose = "APP_ENTITLEMENT_PURPOSE_VALUE_UNSPECIFIED"
	PurposeAppEntitlementPurposeValueAssignment  Purpose = "APP_ENTITLEMENT_PURPOSE_VALUE_ASSIGNMENT"
	PurposeAppEntitlementPurposeValuePermission  Purpose = "APP_ENTITLEMENT_PURPOSE_VALUE_PERMISSION"
)

func (Purpose) ToPointer ¶ added in v1.21.4 

func (e Purpose) ToPointer() *Purpose

type ReassignedAction ¶ added in v1.0.3 

type ReassignedAction struct {
	// The ID of the policy step that was created as a result of this reassignment.
	NewPolicyStepID *string    `json:"newPolicyStepId,omitempty"`
	ReassignedAt    *time.Time `json:"reassignedAt,omitempty"`
	// The UserID of the person who reassigned this step.
	UserID *string `json:"userId,omitempty"`
}

The ReassignedAction object describes the outcome of a policy step that has been reassigned.

func (*ReassignedAction) GetNewPolicyStepID ¶ added in v1.6.1 

func (o *ReassignedAction) GetNewPolicyStepID() *string

func (*ReassignedAction) GetReassignedAt ¶ added in v1.6.1 

func (o *ReassignedAction) GetReassignedAt() *time.Time

func (*ReassignedAction) GetUserID ¶ added in v1.6.1 

func (o *ReassignedAction) GetUserID() *string

func (ReassignedAction) MarshalJSON ¶ added in v1.10.1 

func (r ReassignedAction) MarshalJSON() ([]byte, error)

func (*ReassignedAction) UnmarshalJSON ¶ added in v1.10.1 

func (r *ReassignedAction) UnmarshalJSON(data []byte) error

type ReassignedByErrorAction ¶ added in v1.0.3 

type ReassignedByErrorAction struct {
	// The description of the error with more details on why this was reassigned.
	Description *string `json:"description,omitempty"`
	// Additional information about the error, like http status codes or error messages from SDKs.
	ErrorCode *string `json:"errorCode,omitempty"`
	// The UserID of the user who reassigned this due to an error. This will exclusively be the System's UserID.
	ErrorUserID *string    `json:"errorUserId,omitempty"`
	ErroredAt   *time.Time `json:"erroredAt,omitempty"`
	// The ID of the policy step that was created by this reassignment.
	NewPolicyStepID *string    `json:"newPolicyStepId,omitempty"`
	ReassignedAt    *time.Time `json:"reassignedAt,omitempty"`
}

The ReassignedByErrorAction object describes the outcome of a policy step that has been reassigned because it had an error provisioning.

func (*ReassignedByErrorAction) GetDescription ¶ added in v1.6.1 

func (o *ReassignedByErrorAction) GetDescription() *string

func (*ReassignedByErrorAction) GetErrorCode ¶ added in v1.6.1 

func (o *ReassignedByErrorAction) GetErrorCode() *string

func (*ReassignedByErrorAction) GetErrorUserID ¶ added in v1.6.1 

func (o *ReassignedByErrorAction) GetErrorUserID() *string

func (*ReassignedByErrorAction) GetErroredAt ¶ added in v1.6.1 

func (o *ReassignedByErrorAction) GetErroredAt() *time.Time

func (*ReassignedByErrorAction) GetNewPolicyStepID ¶ added in v1.6.1 

func (o *ReassignedByErrorAction) GetNewPolicyStepID() *string

func (*ReassignedByErrorAction) GetReassignedAt ¶ added in v1.6.1 

func (o *ReassignedByErrorAction) GetReassignedAt() *time.Time

func (ReassignedByErrorAction) MarshalJSON ¶ added in v1.10.1 

func (r ReassignedByErrorAction) MarshalJSON() ([]byte, error)

func (*ReassignedByErrorAction) UnmarshalJSON ¶ added in v1.10.1 

func (r *ReassignedByErrorAction) UnmarshalJSON(data []byte) error

type Recommendation ¶ added in v1.15.0 

type Recommendation string

Recommendation - The recommendation field. 

const (
	RecommendationInsightRecommendationUnspecified Recommendation = "INSIGHT_RECOMMENDATION_UNSPECIFIED"
	RecommendationInsightRecommendationApprove     Recommendation = "INSIGHT_RECOMMENDATION_APPROVE"
	RecommendationInsightRecommendationDeny        Recommendation = "INSIGHT_RECOMMENDATION_DENY"
	RecommendationInsightRecommendationReview      Recommendation = "INSIGHT_RECOMMENDATION_REVIEW"
)

func (Recommendation) ToPointer ¶ added in v1.15.0 

func (e Recommendation) ToPointer() *Recommendation

type ReferenceStrength ¶ added in v1.20.0 

type ReferenceStrength string

ReferenceStrength - GrantReasonReferenceStrength is used to indicate the strength of the reference to the reason. 

This is used to determine if a grant should be removed when all strong reasons are removed.

const (
	ReferenceStrengthGrantReasonReferenceStrengthUnspecified ReferenceStrength = "GRANT_REASON_REFERENCE_STRENGTH_UNSPECIFIED"
	ReferenceStrengthGrantReasonReferenceStrengthWeak        ReferenceStrength = "GRANT_REASON_REFERENCE_STRENGTH_WEAK"
	ReferenceStrengthGrantReasonReferenceStrengthStrong      ReferenceStrength = "GRANT_REASON_REFERENCE_STRENGTH_STRONG"
)

func (ReferenceStrength) ToPointer ¶ added in v1.20.0 

func (e ReferenceStrength) ToPointer() *ReferenceStrength

type Reject ¶ added in v1.10.1 

type Reject struct {
	// An optional message to include in the comments when a task is automatically rejected.
	RejectMessage *string `json:"rejectMessage,omitempty"`
}

Reject - This policy step indicates that a ticket should have a denied outcome. This is a terminal approval state and is used to explicitly define the end of approval steps.

func (*Reject) GetRejectMessage ¶ added in v1.18.3 

func (o *Reject) GetRejectMessage() *string

type RejectInstance ¶ added in v1.10.1 

type RejectInstance struct {
	// An optional message to include in the comments when a task is automatically rejected.
	RejectMessage *string `json:"rejectMessage,omitempty"`
}

RejectInstance - This policy step indicates that a ticket should have a denied outcome. This is a terminal approval state and is used to explicitly define the end of approval steps. 

The instance is just a marker for it being copied into an active policy.

func (*RejectInstance) GetRejectMessage ¶ added in v1.18.3 

func (o *RejectInstance) GetRejectMessage() *string

type RemoveAppEntitlementOwnerRequest ¶ added in v1.8.0 

type RemoveAppEntitlementOwnerRequest struct {
}

RemoveAppEntitlementOwnerRequest - The request message for removing an app entitlement owner.

type RemoveAppEntitlementOwnerResponse ¶ added in v1.8.0 

type RemoveAppEntitlementOwnerResponse struct {
}

RemoveAppEntitlementOwnerResponse - The empty response message for removing an app entitlement owner.

type RemoveAppOwnerRequest ¶ added in v1.1.1 

type RemoveAppOwnerRequest struct {
}

RemoveAppOwnerRequest is the request body for removing an app owner. It uses URL values for input.

type RemoveAppOwnerResponse ¶ added in v1.1.1 

type RemoveAppOwnerResponse struct {
}

RemoveAppOwnerResponse - Empty response with a status code indicating success.

type RequestCatalog ¶ added in v1.6.1 

type RequestCatalog struct {
	// An array of app entitlements that, if the user has, can view the contents of this catalog.
	AccessEntitlements []AppEntitlement `json:"accessEntitlements,omitempty"`
	// The Apps contained in this request catalog.
	AppIds    []string   `json:"appIds,omitempty"`
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// The id of the user this request catalog was created by.
	CreatedByUserID *string    `json:"createdByUserId,omitempty"`
	DeletedAt       *time.Time `json:"deletedAt,omitempty"`
	// The description of the request catalog.
	Description *string `json:"description,omitempty"`
	// The display name of the request catalog.
	DisplayName *string `json:"displayName,omitempty"`
	// Defines how to handle the request policies of the entitlements in the catalog during enrollment.
	EnrollmentBehavior *EnrollmentBehavior `json:"enrollmentBehavior,omitempty"`
	// The id of the request catalog.
	ID *string `json:"id,omitempty"`
	// Whether or not this catalog is published.
	Published *bool `json:"published,omitempty"`
	// Whether all the entitlements in the catalog can be requests at once. Your tenant must have the bundles feature to use this.
	RequestBundle *bool `json:"requestBundle,omitempty"`
	// Defines how to handle the revocation of the entitlements in the catalog during unenrollment.
	UnenrollmentBehavior *UnenrollmentBehavior `json:"unenrollmentBehavior,omitempty"`
	// Defines how to handle the revoke policies of the entitlements in the catalog during unenrollment.
	UnenrollmentEntitlementBehavior *UnenrollmentEntitlementBehavior `json:"unenrollmentEntitlementBehavior,omitempty"`
	UpdatedAt                       *time.Time                       `json:"updatedAt,omitempty"`
	// If this is true, the access entitlement requirement is ignored.
	VisibleToEveryone *bool `json:"visibleToEveryone,omitempty"`
}

The RequestCatalog is used for managing which entitlements are requestable, and who can request them.

func (*RequestCatalog) GetAccessEntitlements ¶ added in v1.6.1 

func (o *RequestCatalog) GetAccessEntitlements() []AppEntitlement

func (*RequestCatalog) GetAppIds ¶ added in v1.6.1 

func (o *RequestCatalog) GetAppIds() []string

func (*RequestCatalog) GetCreatedAt ¶ added in v1.6.1 

func (o *RequestCatalog) GetCreatedAt() *time.Time

func (*RequestCatalog) GetCreatedByUserID ¶ added in v1.6.1 

func (o *RequestCatalog) GetCreatedByUserID() *string

func (*RequestCatalog) GetDeletedAt ¶ added in v1.7.1 

func (o *RequestCatalog) GetDeletedAt() *time.Time

func (*RequestCatalog) GetDescription ¶ added in v1.6.1 

func (o *RequestCatalog) GetDescription() *string

func (*RequestCatalog) GetDisplayName ¶ added in v1.6.1 

func (o *RequestCatalog) GetDisplayName() *string

func (*RequestCatalog) GetEnrollmentBehavior ¶ added in v1.21.3 

func (o *RequestCatalog) GetEnrollmentBehavior() *EnrollmentBehavior

func (*RequestCatalog) GetID ¶ added in v1.6.1 

func (o *RequestCatalog) GetID() *string

func (*RequestCatalog) GetPublished ¶ added in v1.6.1 

func (o *RequestCatalog) GetPublished() *bool

func (*RequestCatalog) GetRequestBundle ¶ added in v1.18.3 

func (o *RequestCatalog) GetRequestBundle() *bool

func (*RequestCatalog) GetUnenrollmentBehavior ¶ added in v1.21.3 

func (o *RequestCatalog) GetUnenrollmentBehavior() *UnenrollmentBehavior

func (*RequestCatalog) GetUnenrollmentEntitlementBehavior ¶ added in v1.21.4 

func (o *RequestCatalog) GetUnenrollmentEntitlementBehavior() *UnenrollmentEntitlementBehavior

func (*RequestCatalog) GetUpdatedAt ¶ added in v1.6.1 

func (o *RequestCatalog) GetUpdatedAt() *time.Time

func (*RequestCatalog) GetVisibleToEveryone ¶ added in v1.6.1 

func (o *RequestCatalog) GetVisibleToEveryone() *bool

func (RequestCatalog) MarshalJSON ¶ added in v1.10.1 

func (r RequestCatalog) MarshalJSON() ([]byte, error)

func (*RequestCatalog) UnmarshalJSON ¶ added in v1.10.1 

func (r *RequestCatalog) UnmarshalJSON(data []byte) error

type RequestCatalogExpandMask ¶ added in v1.6.1 

type RequestCatalogExpandMask struct {
	// An array of paths to be expanded in the response. May be any combination of "*", "created_by_user_id", "app_ids", and "access_entitlements".
	Paths []string `json:"paths,omitempty"`
}

The RequestCatalogExpandMask includes the paths in the catalog view to expand in the return value of this call.

func (*RequestCatalogExpandMask) GetPaths ¶ added in v1.6.1 

func (o *RequestCatalogExpandMask) GetPaths() []string

type RequestCatalogInput ¶ added in v1.7.0 

type RequestCatalogInput struct {
	// An array of app entitlements that, if the user has, can view the contents of this catalog.
	AccessEntitlements []AppEntitlementInput `json:"accessEntitlements,omitempty"`
	// The Apps contained in this request catalog.
	AppIds []string `json:"appIds,omitempty"`
	// The id of the user this request catalog was created by.
	CreatedByUserID *string `json:"createdByUserId,omitempty"`
	// The description of the request catalog.
	Description *string `json:"description,omitempty"`
	// The display name of the request catalog.
	DisplayName *string `json:"displayName,omitempty"`
	// Defines how to handle the request policies of the entitlements in the catalog during enrollment.
	EnrollmentBehavior *EnrollmentBehavior `json:"enrollmentBehavior,omitempty"`
	// The id of the request catalog.
	ID *string `json:"id,omitempty"`
	// Whether or not this catalog is published.
	Published *bool `json:"published,omitempty"`
	// Whether all the entitlements in the catalog can be requests at once. Your tenant must have the bundles feature to use this.
	RequestBundle *bool `json:"requestBundle,omitempty"`
	// Defines how to handle the revocation of the entitlements in the catalog during unenrollment.
	UnenrollmentBehavior *UnenrollmentBehavior `json:"unenrollmentBehavior,omitempty"`
	// Defines how to handle the revoke policies of the entitlements in the catalog during unenrollment.
	UnenrollmentEntitlementBehavior *UnenrollmentEntitlementBehavior `json:"unenrollmentEntitlementBehavior,omitempty"`
	// If this is true, the access entitlement requirement is ignored.
	VisibleToEveryone *bool `json:"visibleToEveryone,omitempty"`
}

RequestCatalogInput - The RequestCatalog is used for managing which entitlements are requestable, and who can request them.

func (*RequestCatalogInput) GetAccessEntitlements ¶ added in v1.7.0 

func (o *RequestCatalogInput) GetAccessEntitlements() []AppEntitlementInput

func (*RequestCatalogInput) GetAppIds ¶ added in v1.7.0 

func (o *RequestCatalogInput) GetAppIds() []string

func (*RequestCatalogInput) GetCreatedByUserID ¶ added in v1.7.0 

func (o *RequestCatalogInput) GetCreatedByUserID() *string

func (*RequestCatalogInput) GetDescription ¶ added in v1.7.0 

func (o *RequestCatalogInput) GetDescription() *string

func (*RequestCatalogInput) GetDisplayName ¶ added in v1.7.0 

func (o *RequestCatalogInput) GetDisplayName() *string

func (*RequestCatalogInput) GetEnrollmentBehavior ¶ added in v1.21.3 

func (o *RequestCatalogInput) GetEnrollmentBehavior() *EnrollmentBehavior

func (*RequestCatalogInput) GetID ¶ added in v1.7.0 

func (o *RequestCatalogInput) GetID() *string

func (*RequestCatalogInput) GetPublished ¶ added in v1.7.0 

func (o *RequestCatalogInput) GetPublished() *bool

func (*RequestCatalogInput) GetRequestBundle ¶ added in v1.18.3 

func (o *RequestCatalogInput) GetRequestBundle() *bool

func (*RequestCatalogInput) GetUnenrollmentBehavior ¶ added in v1.21.3 

func (o *RequestCatalogInput) GetUnenrollmentBehavior() *UnenrollmentBehavior

func (*RequestCatalogInput) GetUnenrollmentEntitlementBehavior ¶ added in v1.21.4 

func (o *RequestCatalogInput) GetUnenrollmentEntitlementBehavior() *UnenrollmentEntitlementBehavior

func (*RequestCatalogInput) GetVisibleToEveryone ¶ added in v1.7.0 

func (o *RequestCatalogInput) GetVisibleToEveryone() *bool

type RequestCatalogManagementServiceAddAccessEntitlementsRequest ¶ added in v1.6.1 

type RequestCatalogManagementServiceAddAccessEntitlementsRequest struct {
	// List of entitlements to add to the request catalog as access entitlements.
	AccessEntitlements []AppEntitlementRef `json:"accessEntitlements,omitempty"`
}

The RequestCatalogManagementServiceAddAccessEntitlementsRequest message is used to add access entitlements to a request 

catalog to determine which users can view the request catalog.

func (*RequestCatalogManagementServiceAddAccessEntitlementsRequest) GetAccessEntitlements ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceAddAccessEntitlementsRequest) GetAccessEntitlements() []AppEntitlementRef

type RequestCatalogManagementServiceAddAccessEntitlementsResponse ¶ added in v1.6.1 

type RequestCatalogManagementServiceAddAccessEntitlementsResponse struct {
}

RequestCatalogManagementServiceAddAccessEntitlementsResponse - Empty response with a status code indicating success.

type RequestCatalogManagementServiceAddAppEntitlementsRequest ¶ added in v1.6.1 

type RequestCatalogManagementServiceAddAppEntitlementsRequest struct {
	// List of entitlements to add to the request catalog.
	AppEntitlements []AppEntitlementRef `json:"appEntitlements,omitempty"`
	// Whether or not to create requests for newly added entitlements for users in the catalog.
	//  By default, this is false and no requests are created.
	CreateRequests *bool `json:"createRequests,omitempty"`
}

The RequestCatalogManagementServiceAddAppEntitlementsRequest object is used to add app requestable app entitlements to a request catalog.

func (*RequestCatalogManagementServiceAddAppEntitlementsRequest) GetAppEntitlements ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceAddAppEntitlementsRequest) GetAppEntitlements() []AppEntitlementRef

func (*RequestCatalogManagementServiceAddAppEntitlementsRequest) GetCreateRequests ¶ added in v1.20.0 

func (o *RequestCatalogManagementServiceAddAppEntitlementsRequest) GetCreateRequests() *bool

type RequestCatalogManagementServiceAddAppEntitlementsResponse ¶ added in v1.6.1 

type RequestCatalogManagementServiceAddAppEntitlementsResponse struct {
}

RequestCatalogManagementServiceAddAppEntitlementsResponse - Empty response with a status code indicating success.

type RequestCatalogManagementServiceCreateRequest ¶ added in v1.6.1 

type RequestCatalogManagementServiceCreateRequest struct {
	// The RequestCatalogExpandMask includes the paths in the catalog view to expand in the return value of this call.
	RequestCatalogExpandMask *RequestCatalogExpandMask `json:"expandMask,omitempty"`
	// The description of the new request catalog.
	Description *string `json:"description,omitempty"`
	// The display name of the new request catalog.
	DisplayName *string `json:"displayName,omitempty"`
	// Whether or not the new catalog should be created as published.
	Published *bool `json:"published,omitempty"`
	// Whether all the entitlements in the catalog can be requests at once. Your tenant must have the bundles feature to use this.
	RequestBundle *bool `json:"requestBundle,omitempty"`
	// Whether or not the new catalog is visible to everyone by default.
	VisibleToEveryone *bool `json:"visibleToEveryone,omitempty"`
}

RequestCatalogManagementServiceCreateRequest - Create a request catalog.

func (*RequestCatalogManagementServiceCreateRequest) GetDescription ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceCreateRequest) GetDescription() *string

func (*RequestCatalogManagementServiceCreateRequest) GetDisplayName ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceCreateRequest) GetDisplayName() *string

func (*RequestCatalogManagementServiceCreateRequest) GetPublished ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceCreateRequest) GetPublished() *bool

func (*RequestCatalogManagementServiceCreateRequest) GetRequestBundle ¶ added in v1.18.3 

func (o *RequestCatalogManagementServiceCreateRequest) GetRequestBundle() *bool

func (*RequestCatalogManagementServiceCreateRequest) GetRequestCatalogExpandMask ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceCreateRequest) GetRequestCatalogExpandMask() *RequestCatalogExpandMask

func (*RequestCatalogManagementServiceCreateRequest) GetVisibleToEveryone ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceCreateRequest) GetVisibleToEveryone() *bool

type RequestCatalogManagementServiceDeleteRequest ¶ added in v1.6.1 

type RequestCatalogManagementServiceDeleteRequest struct {
}

RequestCatalogManagementServiceDeleteRequest - Delete a request catalog by Id. It uses URL value for input.

type RequestCatalogManagementServiceDeleteResponse ¶ added in v1.6.1 

type RequestCatalogManagementServiceDeleteResponse struct {
}

RequestCatalogManagementServiceDeleteResponse - Empty response with a status code indicating success.

type RequestCatalogManagementServiceGetResponse ¶ added in v1.6.1 

type RequestCatalogManagementServiceGetResponse struct {
	// The request catalog view contains the serialized request catalog and paths to objects referenced by the request catalog.
	RequestCatalogView *RequestCatalogView `json:"requestCatalogView,omitempty"`
	// List of serialized related objects.
	Expanded []RequestCatalogManagementServiceGetResponseExpanded `json:"expanded,omitempty"`
}

RequestCatalogManagementServiceGetResponse - The request catalog management service get response returns a request catalog view with the expanded items in the expanded array indicated by the expand mask in the request.

func (*RequestCatalogManagementServiceGetResponse) GetExpanded ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceGetResponse) GetExpanded() []RequestCatalogManagementServiceGetResponseExpanded

func (*RequestCatalogManagementServiceGetResponse) GetRequestCatalogView ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceGetResponse) GetRequestCatalogView() *RequestCatalogView

type RequestCatalogManagementServiceGetResponseExpanded ¶ added in v1.10.1 

type RequestCatalogManagementServiceGetResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

RequestCatalogManagementServiceGetResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*RequestCatalogManagementServiceGetResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *RequestCatalogManagementServiceGetResponseExpanded) GetAdditionalProperties() map[string]any

func (*RequestCatalogManagementServiceGetResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *RequestCatalogManagementServiceGetResponseExpanded) GetAtType() *string

func (RequestCatalogManagementServiceGetResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (r RequestCatalogManagementServiceGetResponseExpanded) MarshalJSON() ([]byte, error)

func (*RequestCatalogManagementServiceGetResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (r *RequestCatalogManagementServiceGetResponseExpanded) UnmarshalJSON(data []byte) error

type RequestCatalogManagementServiceListEntitlementsForAccessResponse ¶ added in v1.6.1 

type RequestCatalogManagementServiceListEntitlementsForAccessResponse struct {
	// List of serialized related objects.
	Expanded []RequestCatalogManagementServiceListEntitlementsForAccessResponseExpanded `json:"expanded,omitempty"`
	// The list of results containing up to X results, where X is the page size defined in the request.
	List []AppEntitlementView `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retreived.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The RequestCatalogManagementServiceListEntitlementsForAccessResponse message contains a list of results and a nextPageToken if applicable.

func (*RequestCatalogManagementServiceListEntitlementsForAccessResponse) GetExpanded ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceListEntitlementsForAccessResponse) GetExpanded() []RequestCatalogManagementServiceListEntitlementsForAccessResponseExpanded

func (*RequestCatalogManagementServiceListEntitlementsForAccessResponse) GetList ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceListEntitlementsForAccessResponse) GetList() []AppEntitlementView

func (*RequestCatalogManagementServiceListEntitlementsForAccessResponse) GetNextPageToken ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceListEntitlementsForAccessResponse) GetNextPageToken() *string

type RequestCatalogManagementServiceListEntitlementsForAccessResponseExpanded ¶ added in v1.10.1 

type RequestCatalogManagementServiceListEntitlementsForAccessResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

RequestCatalogManagementServiceListEntitlementsForAccessResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*RequestCatalogManagementServiceListEntitlementsForAccessResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *RequestCatalogManagementServiceListEntitlementsForAccessResponseExpanded) GetAdditionalProperties() map[string]any

func (*RequestCatalogManagementServiceListEntitlementsForAccessResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *RequestCatalogManagementServiceListEntitlementsForAccessResponseExpanded) GetAtType() *string

func (RequestCatalogManagementServiceListEntitlementsForAccessResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (r RequestCatalogManagementServiceListEntitlementsForAccessResponseExpanded) MarshalJSON() ([]byte, error)

func (*RequestCatalogManagementServiceListEntitlementsForAccessResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (r *RequestCatalogManagementServiceListEntitlementsForAccessResponseExpanded) UnmarshalJSON(data []byte) error

type RequestCatalogManagementServiceListEntitlementsPerCatalogResponse ¶ added in v1.6.1 

type RequestCatalogManagementServiceListEntitlementsPerCatalogResponse struct {
	// List of serialized related objects.
	Expanded []RequestCatalogManagementServiceListEntitlementsPerCatalogResponseExpanded `json:"expanded,omitempty"`
	// The list of results containing up to X results, where X is the page size defined in the request.
	List []AppEntitlementView `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retreived.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The RequestCatalogManagementServiceListEntitlementsPerCatalogResponse message contains a list of results and a nextPageToken if applicable.

func (*RequestCatalogManagementServiceListEntitlementsPerCatalogResponse) GetExpanded ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceListEntitlementsPerCatalogResponse) GetExpanded() []RequestCatalogManagementServiceListEntitlementsPerCatalogResponseExpanded

func (*RequestCatalogManagementServiceListEntitlementsPerCatalogResponse) GetList ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceListEntitlementsPerCatalogResponse) GetList() []AppEntitlementView

func (*RequestCatalogManagementServiceListEntitlementsPerCatalogResponse) GetNextPageToken ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceListEntitlementsPerCatalogResponse) GetNextPageToken() *string

type RequestCatalogManagementServiceListEntitlementsPerCatalogResponseExpanded ¶ added in v1.10.1 

type RequestCatalogManagementServiceListEntitlementsPerCatalogResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

RequestCatalogManagementServiceListEntitlementsPerCatalogResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*RequestCatalogManagementServiceListEntitlementsPerCatalogResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *RequestCatalogManagementServiceListEntitlementsPerCatalogResponseExpanded) GetAdditionalProperties() map[string]any

func (*RequestCatalogManagementServiceListEntitlementsPerCatalogResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *RequestCatalogManagementServiceListEntitlementsPerCatalogResponseExpanded) GetAtType() *string

func (RequestCatalogManagementServiceListEntitlementsPerCatalogResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (r RequestCatalogManagementServiceListEntitlementsPerCatalogResponseExpanded) MarshalJSON() ([]byte, error)

func (*RequestCatalogManagementServiceListEntitlementsPerCatalogResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (r *RequestCatalogManagementServiceListEntitlementsPerCatalogResponseExpanded) UnmarshalJSON(data []byte) error

type RequestCatalogManagementServiceListResponse ¶ added in v1.9.0 

type RequestCatalogManagementServiceListResponse struct {
	// List of serialized related objects.
	Expanded []RequestCatalogManagementServiceListResponseExpanded `json:"expanded,omitempty"`
	// The list of request catalogs.
	List []RequestCatalogView `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retreived.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The RequestCatalogManagementServiceListResponse message.

func (*RequestCatalogManagementServiceListResponse) GetExpanded ¶ added in v1.9.0 

func (o *RequestCatalogManagementServiceListResponse) GetExpanded() []RequestCatalogManagementServiceListResponseExpanded

func (*RequestCatalogManagementServiceListResponse) GetList ¶ added in v1.9.0 

func (o *RequestCatalogManagementServiceListResponse) GetList() []RequestCatalogView

func (*RequestCatalogManagementServiceListResponse) GetNextPageToken ¶ added in v1.9.0 

func (o *RequestCatalogManagementServiceListResponse) GetNextPageToken() *string

type RequestCatalogManagementServiceListResponseExpanded ¶ added in v1.10.1 

type RequestCatalogManagementServiceListResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

RequestCatalogManagementServiceListResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*RequestCatalogManagementServiceListResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *RequestCatalogManagementServiceListResponseExpanded) GetAdditionalProperties() map[string]any

func (*RequestCatalogManagementServiceListResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *RequestCatalogManagementServiceListResponseExpanded) GetAtType() *string

func (RequestCatalogManagementServiceListResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (r RequestCatalogManagementServiceListResponseExpanded) MarshalJSON() ([]byte, error)

func (*RequestCatalogManagementServiceListResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (r *RequestCatalogManagementServiceListResponseExpanded) UnmarshalJSON(data []byte) error

type RequestCatalogManagementServiceRemoveAccessEntitlementsRequest ¶ added in v1.6.1 

type RequestCatalogManagementServiceRemoveAccessEntitlementsRequest struct {
	// The list of access entitlements to remove from the catalog.
	AccessEntitlements []AppEntitlementRef `json:"accessEntitlements,omitempty"`
}

The RequestCatalogManagementServiceRemoveAccessEntitlementsRequest message is used to remove access entitlements from a request catalog. 

The access entitlements are used to determine which users can view the request catalog.

func (*RequestCatalogManagementServiceRemoveAccessEntitlementsRequest) GetAccessEntitlements ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceRemoveAccessEntitlementsRequest) GetAccessEntitlements() []AppEntitlementRef

type RequestCatalogManagementServiceRemoveAccessEntitlementsResponse ¶ added in v1.6.1 

type RequestCatalogManagementServiceRemoveAccessEntitlementsResponse struct {
}

RequestCatalogManagementServiceRemoveAccessEntitlementsResponse - Empty response with a status code indicating success.

type RequestCatalogManagementServiceRemoveAppEntitlementsRequest ¶ added in v1.6.1 

type RequestCatalogManagementServiceRemoveAppEntitlementsRequest struct {
	// The list of app entitlements to remove from the catalog.
	AppEntitlements []AppEntitlementRef `json:"appEntitlements,omitempty"`
}

The RequestCatalogManagementServiceRemoveAppEntitlementsRequest message is used to remove app entitlements from a request catalog.

func (*RequestCatalogManagementServiceRemoveAppEntitlementsRequest) GetAppEntitlements ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceRemoveAppEntitlementsRequest) GetAppEntitlements() []AppEntitlementRef

type RequestCatalogManagementServiceRemoveAppEntitlementsResponse ¶ added in v1.6.1 

type RequestCatalogManagementServiceRemoveAppEntitlementsResponse struct {
}

RequestCatalogManagementServiceRemoveAppEntitlementsResponse - Empty response with a status code indicating success

type RequestCatalogManagementServiceUpdateRequest ¶ added in v1.6.1 

type RequestCatalogManagementServiceUpdateRequest struct {
	// The RequestCatalog is used for managing which entitlements are requestable, and who can request them.
	RequestCatalog *RequestCatalogInput `json:"catalog,omitempty"`
	// The RequestCatalogExpandMask includes the paths in the catalog view to expand in the return value of this call.
	RequestCatalogExpandMask *RequestCatalogExpandMask `json:"expandMask,omitempty"`
	UpdateMask               *string                   `json:"updateMask,omitempty"`
}

RequestCatalogManagementServiceUpdateRequest - Update a request catalog object by ID.

func (*RequestCatalogManagementServiceUpdateRequest) GetRequestCatalog ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceUpdateRequest) GetRequestCatalog() *RequestCatalogInput

func (*RequestCatalogManagementServiceUpdateRequest) GetRequestCatalogExpandMask ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceUpdateRequest) GetRequestCatalogExpandMask() *RequestCatalogExpandMask

func (*RequestCatalogManagementServiceUpdateRequest) GetUpdateMask ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceUpdateRequest) GetUpdateMask() *string

type RequestCatalogSearchServiceSearchEntitlementsRequest ¶ added in v1.0.3 

type RequestCatalogSearchServiceSearchEntitlementsRequest struct {
	// The app entitlement expand mask allows the user to get additional information when getting responses containing app entitlement views.
	AppEntitlementExpandMask *AppEntitlementExpandMask `json:"expandMask,omitempty"`
	// Search entitlements that belong to this app name (exact match).
	AppDisplayName *string `json:"appDisplayName,omitempty"`
	// Search for entitlements with this alias (exact match).
	EntitlementAlias *string `json:"entitlementAlias,omitempty"`
	// Search entitlements with this granted status for your signed in user.
	GrantedStatus *GrantedStatus `json:"grantedStatus,omitempty"`
	// Include deleted entitlements
	IncludeDeleted *bool `json:"includeDeleted,omitempty"`
	// The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)
	PageSize *int `json:"pageSize,omitempty"`
	// The pageToken field.
	PageToken *string `json:"pageToken,omitempty"`
	// Fuzzy search the display name of resource types.
	Query *string `json:"query,omitempty"`
}

The RequestCatalogSearchServiceSearchEntitlementsRequest searches entitlements, but only ones that are available to you through the open catalogs.

func (*RequestCatalogSearchServiceSearchEntitlementsRequest) GetAppDisplayName ¶ added in v1.7.1 

func (o *RequestCatalogSearchServiceSearchEntitlementsRequest) GetAppDisplayName() *string

func (*RequestCatalogSearchServiceSearchEntitlementsRequest) GetAppEntitlementExpandMask ¶ added in v1.6.1 

func (o *RequestCatalogSearchServiceSearchEntitlementsRequest) GetAppEntitlementExpandMask() *AppEntitlementExpandMask

func (*RequestCatalogSearchServiceSearchEntitlementsRequest) GetEntitlementAlias ¶ added in v1.6.1 

func (o *RequestCatalogSearchServiceSearchEntitlementsRequest) GetEntitlementAlias() *string

func (*RequestCatalogSearchServiceSearchEntitlementsRequest) GetGrantedStatus ¶ added in v1.6.1 

func (o *RequestCatalogSearchServiceSearchEntitlementsRequest) GetGrantedStatus() *GrantedStatus

func (*RequestCatalogSearchServiceSearchEntitlementsRequest) GetIncludeDeleted ¶ added in v1.9.0 

func (o *RequestCatalogSearchServiceSearchEntitlementsRequest) GetIncludeDeleted() *bool

func (*RequestCatalogSearchServiceSearchEntitlementsRequest) GetPageSize ¶ added in v1.6.1 

func (o *RequestCatalogSearchServiceSearchEntitlementsRequest) GetPageSize() *int

func (*RequestCatalogSearchServiceSearchEntitlementsRequest) GetPageToken ¶ added in v1.6.1 

func (o *RequestCatalogSearchServiceSearchEntitlementsRequest) GetPageToken() *string

func (*RequestCatalogSearchServiceSearchEntitlementsRequest) GetQuery ¶ added in v1.6.1 

func (o *RequestCatalogSearchServiceSearchEntitlementsRequest) GetQuery() *string

type RequestCatalogSearchServiceSearchEntitlementsResponse ¶ added in v1.0.3 

type RequestCatalogSearchServiceSearchEntitlementsResponse struct {
	// List of serialized related objects.
	Expanded []RequestCatalogSearchServiceSearchEntitlementsResponseExpanded `json:"expanded,omitempty"`
	// The list of results containing up to X results, where X is the page size defined in the request.
	List []AppEntitlementWithUserBindings `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retreived.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The RequestCatalogSearchServiceSearchEntitlementsResponse message contains a list of results and a nextPageToken if applicable.

func (*RequestCatalogSearchServiceSearchEntitlementsResponse) GetExpanded ¶ added in v1.6.1 

func (o *RequestCatalogSearchServiceSearchEntitlementsResponse) GetExpanded() []RequestCatalogSearchServiceSearchEntitlementsResponseExpanded

func (*RequestCatalogSearchServiceSearchEntitlementsResponse) GetList ¶ added in v1.6.1 

func (o *RequestCatalogSearchServiceSearchEntitlementsResponse) GetList() []AppEntitlementWithUserBindings

func (*RequestCatalogSearchServiceSearchEntitlementsResponse) GetNextPageToken ¶ added in v1.6.1 

func (o *RequestCatalogSearchServiceSearchEntitlementsResponse) GetNextPageToken() *string

type RequestCatalogSearchServiceSearchEntitlementsResponseExpanded ¶ added in v1.10.1 

type RequestCatalogSearchServiceSearchEntitlementsResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

RequestCatalogSearchServiceSearchEntitlementsResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*RequestCatalogSearchServiceSearchEntitlementsResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *RequestCatalogSearchServiceSearchEntitlementsResponseExpanded) GetAdditionalProperties() map[string]any

func (*RequestCatalogSearchServiceSearchEntitlementsResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *RequestCatalogSearchServiceSearchEntitlementsResponseExpanded) GetAtType() *string

func (RequestCatalogSearchServiceSearchEntitlementsResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (r RequestCatalogSearchServiceSearchEntitlementsResponseExpanded) MarshalJSON() ([]byte, error)

func (*RequestCatalogSearchServiceSearchEntitlementsResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (r *RequestCatalogSearchServiceSearchEntitlementsResponseExpanded) UnmarshalJSON(data []byte) error

type RequestCatalogView ¶ added in v1.6.1 

type RequestCatalogView struct {
	// The RequestCatalog is used for managing which entitlements are requestable, and who can request them.
	RequestCatalog *RequestCatalog `json:"requestCatalog,omitempty"`
	// JSONPATH expression indicating the location of the access entitlement objects, that the request catalog allows users to request, in the array.
	AccessEntitlementsPath *string `json:"accessEntitlementsPath,omitempty"`
	// JSONPATH expression indicating the location of the App object in the array.
	AppPaths *string `json:"appPaths,omitempty"`
	// JSONPATH expression indicating the location of the User object, that created the request catalog, in the array.
	CreatedByUserPath *string `json:"createdByUserPath,omitempty"`
	// Total number of the members of the catalog
	MemberCount *int64 `integer:"string" json:"memberCount,omitempty"`
}

RequestCatalogView - The request catalog view contains the serialized request catalog and paths to objects referenced by the request catalog.

func (*RequestCatalogView) GetAccessEntitlementsPath ¶ added in v1.6.1 

func (o *RequestCatalogView) GetAccessEntitlementsPath() *string

func (*RequestCatalogView) GetAppPaths ¶ added in v1.6.1 

func (o *RequestCatalogView) GetAppPaths() *string

func (*RequestCatalogView) GetCreatedByUserPath ¶ added in v1.6.1 

func (o *RequestCatalogView) GetCreatedByUserPath() *string

func (*RequestCatalogView) GetMemberCount ¶ added in v1.20.0 

func (o *RequestCatalogView) GetMemberCount() *int64

func (*RequestCatalogView) GetRequestCatalog ¶ added in v1.6.1 

func (o *RequestCatalogView) GetRequestCatalog() *RequestCatalog

type ResourceOwnerApproval ¶ added in v1.20.0 

type ResourceOwnerApproval struct {
	// Configuration to allow self approval if the target user is an resource owner during this step.
	AllowSelfApproval *bool `json:"allowSelfApproval,omitempty"`
	// Configuration to allow a fallback if the resource owner cannot be identified.
	Fallback *bool `json:"fallback,omitempty"`
	// Configuration to specific which users to fallback to if fallback is enabled and the resource owner cannot be identified.
	FallbackUserIds []string `json:"fallbackUserIds,omitempty"`
}

ResourceOwnerApproval - The resource owner approval allows configuration of the approval step when the target approvers are the resource owners.

func (*ResourceOwnerApproval) GetAllowSelfApproval ¶ added in v1.20.0 

func (o *ResourceOwnerApproval) GetAllowSelfApproval() *bool

func (*ResourceOwnerApproval) GetFallback ¶ added in v1.20.0 

func (o *ResourceOwnerApproval) GetFallback() *bool

func (*ResourceOwnerApproval) GetFallbackUserIds ¶ added in v1.20.0 

func (o *ResourceOwnerApproval) GetFallbackUserIds() []string

type ResourceType ¶ added in v1.20.0 

type ResourceType string

ResourceType - The resourceType field. 

const (
	ResourceTypeRole    ResourceType = "ROLE"
	ResourceTypeGroup   ResourceType = "GROUP"
	ResourceTypeLicense ResourceType = "LICENSE"
	ResourceTypeProject ResourceType = "PROJECT"
	ResourceTypeCatalog ResourceType = "CATALOG"
	ResourceTypeCustom  ResourceType = "CUSTOM"
)

func (ResourceType) ToPointer ¶ added in v1.20.0 

func (e ResourceType) ToPointer() *ResourceType

type ResponsePolicyApprovalReplacePolicy ¶ added in v1.19.0 

type ResponsePolicyApprovalReplacePolicy struct {
	// The comment field.
	Comment *string `json:"comment,omitempty"`
	// The policySteps field.
	PolicySteps []PolicyStep `json:"policySteps,omitempty"`
}

The ResponsePolicyApprovalReplacePolicy message.

func (*ResponsePolicyApprovalReplacePolicy) GetComment ¶ added in v1.19.0 

func (o *ResponsePolicyApprovalReplacePolicy) GetComment() *string

func (*ResponsePolicyApprovalReplacePolicy) GetPolicySteps ¶ added in v1.19.0 

func (o *ResponsePolicyApprovalReplacePolicy) GetPolicySteps() []PolicyStep

type ResponsePolicyApprovalStep ¶ added in v1.19.0 

type ResponsePolicyApprovalStep struct {
	// The ResponsePolicyApprovalReplacePolicy message.
	ResponsePolicyApprovalReplacePolicy *ResponsePolicyApprovalReplacePolicy `json:"replacePolicy,omitempty"`
	// The ResponsePolicyApprovalStepApprove message.
	ResponsePolicyApprovalStepApprove *ResponsePolicyApprovalStepApprove `json:"approve,omitempty"`
	// The ResponsePolicyApprovalStepDeny message.
	ResponsePolicyApprovalStepDeny *ResponsePolicyApprovalStepDeny `json:"deny,omitempty"`
	// The ResponsePolicyApprovalStepReassign message.
	ResponsePolicyApprovalStepReassign *ResponsePolicyApprovalStepReassign `json:"reassign,omitempty"`
	// version contains the constant value "v1". Future versions of the Webhook Response
	//  will use a different string.
	Version *string `json:"version,omitempty"`
}

The ResponsePolicyApprovalStep message.

This message contains a oneof named action. Only a single field of the following list may be set at a time:

  • approve
  • deny
  • reassign
  • replacePolicy

func (*ResponsePolicyApprovalStep) GetResponsePolicyApprovalReplacePolicy ¶ added in v1.19.0 

func (o *ResponsePolicyApprovalStep) GetResponsePolicyApprovalReplacePolicy() *ResponsePolicyApprovalReplacePolicy

func (*ResponsePolicyApprovalStep) GetResponsePolicyApprovalStepApprove ¶ added in v1.19.0 

func (o *ResponsePolicyApprovalStep) GetResponsePolicyApprovalStepApprove() *ResponsePolicyApprovalStepApprove

func (*ResponsePolicyApprovalStep) GetResponsePolicyApprovalStepDeny ¶ added in v1.19.0 

func (o *ResponsePolicyApprovalStep) GetResponsePolicyApprovalStepDeny() *ResponsePolicyApprovalStepDeny

func (*ResponsePolicyApprovalStep) GetResponsePolicyApprovalStepReassign ¶ added in v1.19.0 

func (o *ResponsePolicyApprovalStep) GetResponsePolicyApprovalStepReassign() *ResponsePolicyApprovalStepReassign

func (*ResponsePolicyApprovalStep) GetVersion ¶ added in v1.19.0 

func (o *ResponsePolicyApprovalStep) GetVersion() *string

type ResponsePolicyApprovalStepApprove ¶ added in v1.19.0 

type ResponsePolicyApprovalStepApprove struct {
	// optional comment
	Comment *string `json:"comment,omitempty"`
}

The ResponsePolicyApprovalStepApprove message.

func (*ResponsePolicyApprovalStepApprove) GetComment ¶ added in v1.19.0 

func (o *ResponsePolicyApprovalStepApprove) GetComment() *string

type ResponsePolicyApprovalStepDeny ¶ added in v1.19.0 

type ResponsePolicyApprovalStepDeny struct {
	// optional comment
	Comment *string `json:"comment,omitempty"`
}

The ResponsePolicyApprovalStepDeny message.

func (*ResponsePolicyApprovalStepDeny) GetComment ¶ added in v1.19.0 

func (o *ResponsePolicyApprovalStepDeny) GetComment() *string

type ResponsePolicyApprovalStepReassign ¶ added in v1.19.0 

type ResponsePolicyApprovalStepReassign struct {
	// optional comment
	Comment *string `json:"comment,omitempty"`
	// The newStepUserIds field.
	NewStepUserIds []string `json:"newStepUserIds,omitempty"`
}

The ResponsePolicyApprovalStepReassign message.

func (*ResponsePolicyApprovalStepReassign) GetComment ¶ added in v1.19.0 

func (o *ResponsePolicyApprovalStepReassign) GetComment() *string

func (*ResponsePolicyApprovalStepReassign) GetNewStepUserIds ¶ added in v1.19.0 

func (o *ResponsePolicyApprovalStepReassign) GetNewStepUserIds() []string

type ResponsePolicyPostAction ¶ added in v1.19.0 

type ResponsePolicyPostAction struct {
	// version contains the constant value "v1". Future versions of the Webhook Response
	//  will use a different string.
	Version *string `json:"version,omitempty"`
}

The ResponsePolicyPostAction message.

func (*ResponsePolicyPostAction) GetVersion ¶ added in v1.19.0 

func (o *ResponsePolicyPostAction) GetVersion() *string

type ResponseProvisionStep ¶ added in v1.19.0 

type ResponseProvisionStep struct {
	// The ResponseProvisionStepComplete message.
	ResponseProvisionStepComplete *ResponseProvisionStepComplete `json:"complete,omitempty"`
	// The ResponseProvisionStepErrored message.
	ResponseProvisionStepErrored *ResponseProvisionStepErrored `json:"errored,omitempty"`
	// version contains the constant value "v1". Future versions of the Webhook Response
	//  will use a different string.
	Version *string `json:"version,omitempty"`
}

The ResponseProvisionStep message.

This message contains a oneof named outcome. Only a single field of the following list may be set at a time:

  • complete
  • errored

func (*ResponseProvisionStep) GetResponseProvisionStepComplete ¶ added in v1.19.0 

func (o *ResponseProvisionStep) GetResponseProvisionStepComplete() *ResponseProvisionStepComplete

func (*ResponseProvisionStep) GetResponseProvisionStepErrored ¶ added in v1.19.0 

func (o *ResponseProvisionStep) GetResponseProvisionStepErrored() *ResponseProvisionStepErrored

func (*ResponseProvisionStep) GetVersion ¶ added in v1.19.0 

func (o *ResponseProvisionStep) GetVersion() *string

type ResponseProvisionStepComplete ¶ added in v1.19.0 

type ResponseProvisionStepComplete struct {
	// optional comment
	Comment *string `json:"comment,omitempty"`
}

The ResponseProvisionStepComplete message.

func (*ResponseProvisionStepComplete) GetComment ¶ added in v1.19.0 

func (o *ResponseProvisionStepComplete) GetComment() *string

type ResponseProvisionStepErrored ¶ added in v1.19.0 

type ResponseProvisionStepErrored struct {
	// optional comment
	Comment *string `json:"comment,omitempty"`
}

The ResponseProvisionStepErrored message.

func (*ResponseProvisionStepErrored) GetComment ¶ added in v1.19.0 

func (o *ResponseProvisionStepErrored) GetComment() *string

type ResponseTest ¶ added in v1.19.0 

type ResponseTest struct {
	// version contains the constant value "v1". Future versions of the Webhook Response
	//  will use a different string.
	Version *string `json:"version,omitempty"`
}

The ResponseTest message.

func (*ResponseTest) GetVersion ¶ added in v1.19.0 

func (o *ResponseTest) GetVersion() *string

type RestartAction ¶ added in v1.0.3 

type RestartAction struct {
	// The step ID that was restarted. Potentially multiple "history" steps will reference this ID to indicate by what step they were restarted.
	OldPolicyStepID *string    `json:"oldPolicyStepId,omitempty"`
	RestartedAt     *time.Time `json:"restartedAt,omitempty"`
	// The user that submitted the restart action.
	UserID *string `json:"userId,omitempty"`
}

RestartAction - The restart action describes the outcome of policy steps for when the task was restarted. This can be applied to multiple steps since restart skips all pending next steps.

func (*RestartAction) GetOldPolicyStepID ¶ added in v1.6.1 

func (o *RestartAction) GetOldPolicyStepID() *string

func (*RestartAction) GetRestartedAt ¶ added in v1.6.1 

func (o *RestartAction) GetRestartedAt() *time.Time

func (*RestartAction) GetUserID ¶ added in v1.6.1 

func (o *RestartAction) GetUserID() *string

func (RestartAction) MarshalJSON ¶ added in v1.10.1 

func (r RestartAction) MarshalJSON() ([]byte, error)

func (*RestartAction) UnmarshalJSON ¶ added in v1.10.1 

func (r *RestartAction) UnmarshalJSON(data []byte) error

type Role ¶ added in v1.0.3 

type Role struct {
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
	// The display name of the role.
	DisplayName *string `json:"displayName,omitempty"`
	// The id of the role.
	ID *string `json:"id,omitempty"`
	// The internal name of the role.
	Name *string `json:"name,omitempty"`
	// The list of permissions this role has.
	Permissions []string `json:"permissions,omitempty"`
	// The list of serviceRoles that this role has.
	ServiceRoles []string `json:"serviceRoles,omitempty"`
	// This Role is intended for API keys usage only, and the user interface may not function as expected.
	SystemAPIOnly *bool `json:"systemApiOnly,omitempty"`
	// The system builtin field. If this field is set, the role is not editable.
	SystemBuiltin *bool      `json:"systemBuiltin,omitempty"`
	UpdatedAt     *time.Time `json:"updatedAt,omitempty"`
}

Role is a role that can be assigned to a user in ConductorOne.

func (*Role) GetCreatedAt ¶ added in v1.6.1 

func (o *Role) GetCreatedAt() *time.Time

func (*Role) GetDeletedAt ¶ added in v1.6.1 

func (o *Role) GetDeletedAt() *time.Time

func (*Role) GetDisplayName ¶ added in v1.6.1 

func (o *Role) GetDisplayName() *string

func (*Role) GetID ¶ added in v1.6.1 

func (o *Role) GetID() *string

func (*Role) GetName ¶ added in v1.6.1 

func (o *Role) GetName() *string

func (*Role) GetPermissions ¶ added in v1.6.1 

func (o *Role) GetPermissions() []string

func (*Role) GetServiceRoles ¶ added in v1.6.1 

func (o *Role) GetServiceRoles() []string

func (*Role) GetSystemAPIOnly ¶ added in v1.19.0 

func (o *Role) GetSystemAPIOnly() *bool

func (*Role) GetSystemBuiltin ¶ added in v1.6.1 

func (o *Role) GetSystemBuiltin() *bool

func (*Role) GetUpdatedAt ¶ added in v1.6.1 

func (o *Role) GetUpdatedAt() *time.Time

func (Role) MarshalJSON ¶ added in v1.10.1 

func (r Role) MarshalJSON() ([]byte, error)

func (*Role) UnmarshalJSON ¶ added in v1.10.1 

func (r *Role) UnmarshalJSON(data []byte) error

type RoleInput ¶ added in v1.7.0 

type RoleInput struct {
	// The display name of the role.
	DisplayName *string `json:"displayName,omitempty"`
	// The list of permissions this role has.
	Permissions []string `json:"permissions,omitempty"`
	// The list of serviceRoles that this role has.
	ServiceRoles []string `json:"serviceRoles,omitempty"`
}

RoleInput - Role is a role that can be assigned to a user in ConductorOne.

func (*RoleInput) GetDisplayName ¶ added in v1.7.0 

func (o *RoleInput) GetDisplayName() *string

func (*RoleInput) GetPermissions ¶ added in v1.7.0 

func (o *RoleInput) GetPermissions() []string

func (*RoleInput) GetServiceRoles ¶ added in v1.7.0 

func (o *RoleInput) GetServiceRoles() []string

type Rule ¶ added in v1.9.0 

type Rule struct {
	// The condition field.
	Condition *string `json:"condition,omitempty"`
	// This is a reference to a list of policy steps from `policy_steps`
	PolicyKey *string `json:"policyKey,omitempty"`
}

The Rule message.

func (*Rule) GetCondition ¶ added in v1.9.0 

func (o *Rule) GetCondition() *string

func (*Rule) GetPolicyKey ¶ added in v1.9.0 

func (o *Rule) GetPolicyKey() *string

type SearchAppEntitlementsWithExpiredResponse ¶ added in v1.18.3 

type SearchAppEntitlementsWithExpiredResponse struct {
	// The list field.
	List []AppEntitlementWithExpired `json:"list,omitempty"`
	// The nextPageToken field.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The SearchAppEntitlementsWithExpiredResponse message contains a list of results and a nextPageToken if applicable.

func (*SearchAppEntitlementsWithExpiredResponse) GetList ¶ added in v1.18.3 

func (o *SearchAppEntitlementsWithExpiredResponse) GetList() []AppEntitlementWithExpired

func (*SearchAppEntitlementsWithExpiredResponse) GetNextPageToken ¶ added in v1.18.3 

func (o *SearchAppEntitlementsWithExpiredResponse) GetNextPageToken() *string

type SearchAppResourceTypesRequest ¶ added in v1.0.3 

type SearchAppResourceTypesRequest struct {
	// A list of app IDs to restrict the search by.
	AppIds []string `json:"appIds,omitempty"`
	// A list of app user IDs to restrict the search by.
	AppUserIds []string `json:"appUserIds,omitempty"`
	// A list of resource type IDs to exclude from the search.
	ExcludeResourceTypeIds []string `json:"excludeResourceTypeIds,omitempty"`
	// A list of resource type trait IDs to exclude from the search.
	ExcludeResourceTypeTraitIds []string `json:"excludeResourceTypeTraitIds,omitempty"`
	// The pageSize where 10 <= pageSize <= 100, default 25.
	PageSize *int `json:"pageSize,omitempty"`
	// The pageToken field.
	PageToken *string `json:"pageToken,omitempty"`
	// Fuzzy search the display name of resource types.
	Query *string `json:"query,omitempty"`
	// A list of resource type IDs to restrict the search by.
	ResourceTypeIds []string `json:"resourceTypeIds,omitempty"`
	// A list of resource type trait IDs to restrict the search by.
	ResourceTypeTraitIds []string `json:"resourceTypeTraitIds,omitempty"`
}

SearchAppResourceTypesRequest - Search for app resources based on some filters.

func (*SearchAppResourceTypesRequest) GetAppIds ¶ added in v1.6.1 

func (o *SearchAppResourceTypesRequest) GetAppIds() []string

func (*SearchAppResourceTypesRequest) GetAppUserIds ¶ added in v1.16.0 

func (o *SearchAppResourceTypesRequest) GetAppUserIds() []string

func (*SearchAppResourceTypesRequest) GetExcludeResourceTypeIds ¶ added in v1.6.1 

func (o *SearchAppResourceTypesRequest) GetExcludeResourceTypeIds() []string

func (*SearchAppResourceTypesRequest) GetExcludeResourceTypeTraitIds ¶ added in v1.6.1 

func (o *SearchAppResourceTypesRequest) GetExcludeResourceTypeTraitIds() []string

func (*SearchAppResourceTypesRequest) GetPageSize ¶ added in v1.6.1 

func (o *SearchAppResourceTypesRequest) GetPageSize() *int

func (*SearchAppResourceTypesRequest) GetPageToken ¶ added in v1.6.1 

func (o *SearchAppResourceTypesRequest) GetPageToken() *string

func (*SearchAppResourceTypesRequest) GetQuery ¶ added in v1.6.1 

func (o *SearchAppResourceTypesRequest) GetQuery() *string

func (*SearchAppResourceTypesRequest) GetResourceTypeIds ¶ added in v1.6.1 

func (o *SearchAppResourceTypesRequest) GetResourceTypeIds() []string

func (*SearchAppResourceTypesRequest) GetResourceTypeTraitIds ¶ added in v1.6.1 

func (o *SearchAppResourceTypesRequest) GetResourceTypeTraitIds() []string

type SearchAppResourceTypesResponse ¶ added in v1.0.3 

type SearchAppResourceTypesResponse struct {
	// The list of results containing up to X results, where X is the page size defined in the request.
	List []AppResourceType `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retreived.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The SearchAppResourceTypesResponse message contains a list of results and a nextPageToken if applicable.

func (*SearchAppResourceTypesResponse) GetList ¶ added in v1.6.1 

func (o *SearchAppResourceTypesResponse) GetList() []AppResourceType

func (*SearchAppResourceTypesResponse) GetNextPageToken ¶ added in v1.6.1 

func (o *SearchAppResourceTypesResponse) GetNextPageToken() *string

type SearchAppsRequest ¶ added in v1.0.3 

type SearchAppsRequest struct {
	// A list of app IDs to restrict the search to.
	AppIds []string `json:"appIds,omitempty"`
	// Search for apps with a case insensitive match on the display name.
	DisplayName *string `json:"displayName,omitempty"`
	// A list of app IDs to remove from the results.
	ExcludeAppIds []string `json:"excludeAppIds,omitempty"`
	// Only return apps which are directories
	OnlyDirectories *bool `json:"onlyDirectories,omitempty"`
	// The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)
	PageSize *int `json:"pageSize,omitempty"`
	// The pageToken field.
	PageToken *string `json:"pageToken,omitempty"`
	// Query the apps with a fuzzy search on display name and description.
	Query *string `json:"query,omitempty"`
}

SearchAppsRequest - Search Apps by a few properties.

func (*SearchAppsRequest) GetAppIds ¶ added in v1.6.1 

func (o *SearchAppsRequest) GetAppIds() []string

func (*SearchAppsRequest) GetDisplayName ¶ added in v1.7.0 

func (o *SearchAppsRequest) GetDisplayName() *string

func (*SearchAppsRequest) GetExcludeAppIds ¶ added in v1.6.1 

func (o *SearchAppsRequest) GetExcludeAppIds() []string

func (*SearchAppsRequest) GetOnlyDirectories ¶ added in v1.15.0 

func (o *SearchAppsRequest) GetOnlyDirectories() *bool

func (*SearchAppsRequest) GetPageSize ¶ added in v1.6.1 

func (o *SearchAppsRequest) GetPageSize() *int

func (*SearchAppsRequest) GetPageToken ¶ added in v1.6.1 

func (o *SearchAppsRequest) GetPageToken() *string

func (*SearchAppsRequest) GetQuery ¶ added in v1.6.1 

func (o *SearchAppsRequest) GetQuery() *string

type SearchAppsResponse ¶ added in v1.0.3 

type SearchAppsResponse struct {
	// The list of results containing up to X results, where X is the page size defined in the request.
	List []App `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retreived.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The SearchAppsResponse message contains a list of results and a nextPageToken if applicable.

func (*SearchAppsResponse) GetList ¶ added in v1.6.1 

func (o *SearchAppsResponse) GetList() []App

func (*SearchAppsResponse) GetNextPageToken ¶ added in v1.6.1 

func (o *SearchAppsResponse) GetNextPageToken() *string

type SearchAttributeValuesRequest ¶ added in v1.8.0 

type SearchAttributeValuesRequest struct {
	// The attribute type ids for what type of attributes to search for.
	AttributeTypeIds []string `json:"attributeTypeIds,omitempty"`
	// Exclude attributes with these ids from the search results.
	ExcludeIds []string `json:"excludeIds,omitempty"`
	// Include attributes with these ids in the search results.
	Ids []string `json:"ids,omitempty"`
	// The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)
	PageSize *int `json:"pageSize,omitempty"`
	// The pageToken field.
	PageToken *string `json:"pageToken,omitempty"`
	// Query the attributes with a fuzzy search on display name and description.
	Query *string `json:"query,omitempty"`
	// Search for attributes with a case insensitive match on the attribute value which is the attribute name.
	Value *string `json:"value,omitempty"`
}

SearchAttributeValuesRequest - Search Attributes by a few properties.

func (*SearchAttributeValuesRequest) GetAttributeTypeIds ¶ added in v1.8.0 

func (o *SearchAttributeValuesRequest) GetAttributeTypeIds() []string

func (*SearchAttributeValuesRequest) GetExcludeIds ¶ added in v1.8.0 

func (o *SearchAttributeValuesRequest) GetExcludeIds() []string

func (*SearchAttributeValuesRequest) GetIds ¶ added in v1.8.0 

func (o *SearchAttributeValuesRequest) GetIds() []string

func (*SearchAttributeValuesRequest) GetPageSize ¶ added in v1.8.0 

func (o *SearchAttributeValuesRequest) GetPageSize() *int

func (*SearchAttributeValuesRequest) GetPageToken ¶ added in v1.8.0 

func (o *SearchAttributeValuesRequest) GetPageToken() *string

func (*SearchAttributeValuesRequest) GetQuery ¶ added in v1.8.0 

func (o *SearchAttributeValuesRequest) GetQuery() *string

func (*SearchAttributeValuesRequest) GetValue ¶ added in v1.8.0 

func (o *SearchAttributeValuesRequest) GetValue() *string

type SearchAttributeValuesResponse ¶ added in v1.8.0 

type SearchAttributeValuesResponse struct {
	// The list of returned AttributeValues.
	List []AttributeValue `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retreived.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

SearchAttributeValuesResponse is the response for searching AttributeValues.

func (*SearchAttributeValuesResponse) GetList ¶ added in v1.8.0 

func (o *SearchAttributeValuesResponse) GetList() []AttributeValue

func (*SearchAttributeValuesResponse) GetNextPageToken ¶ added in v1.8.0 

func (o *SearchAttributeValuesResponse) GetNextPageToken() *string

type SearchGrantFeedResponse ¶ added in v1.20.0 

type SearchGrantFeedResponse struct {
	// The expanded field.
	Expanded []SearchGrantFeedResponseExpanded `json:"expanded,omitempty"`
	// The list of results containing up to X results, where X is the page size defined in the request.
	List []AppEntitlementUserBindingFeedView `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retrieved.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The SearchGrantFeedResponse message contains a list of grant event results and a nextPageToken if applicable.

func (*SearchGrantFeedResponse) GetExpanded ¶ added in v1.20.0 

func (o *SearchGrantFeedResponse) GetExpanded() []SearchGrantFeedResponseExpanded

func (*SearchGrantFeedResponse) GetList ¶ added in v1.20.0 

func (o *SearchGrantFeedResponse) GetList() []AppEntitlementUserBindingFeedView

func (*SearchGrantFeedResponse) GetNextPageToken ¶ added in v1.20.0 

func (o *SearchGrantFeedResponse) GetNextPageToken() *string

type SearchGrantFeedResponseExpanded ¶ added in v1.20.0 

type SearchGrantFeedResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

SearchGrantFeedResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*SearchGrantFeedResponseExpanded) GetAdditionalProperties ¶ added in v1.20.0 

func (o *SearchGrantFeedResponseExpanded) GetAdditionalProperties() map[string]any

func (*SearchGrantFeedResponseExpanded) GetAtType ¶ added in v1.20.0 

func (o *SearchGrantFeedResponseExpanded) GetAtType() *string

func (SearchGrantFeedResponseExpanded) MarshalJSON ¶ added in v1.20.0 

func (s SearchGrantFeedResponseExpanded) MarshalJSON() ([]byte, error)

func (*SearchGrantFeedResponseExpanded) UnmarshalJSON ¶ added in v1.20.0 

func (s *SearchGrantFeedResponseExpanded) UnmarshalJSON(data []byte) error

type SearchPastGrantsResponse ¶ added in v1.19.0 

type SearchPastGrantsResponse struct {
	// The expanded field.
	Expanded []SearchPastGrantsResponseExpanded `json:"expanded,omitempty"`
	// The list of results containing up to X results, where X is the page size defined in the request.
	List []AppEntitlementUserBindingHistoryView `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retrieved.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The SearchPastGrantsResponse message contains a list of past grants and a nextPageToken if applicable.

func (*SearchPastGrantsResponse) GetExpanded ¶ added in v1.19.0 

func (o *SearchPastGrantsResponse) GetExpanded() []SearchPastGrantsResponseExpanded

func (*SearchPastGrantsResponse) GetList ¶ added in v1.19.0 

func (o *SearchPastGrantsResponse) GetList() []AppEntitlementUserBindingHistoryView

func (*SearchPastGrantsResponse) GetNextPageToken ¶ added in v1.19.0 

func (o *SearchPastGrantsResponse) GetNextPageToken() *string

type SearchPastGrantsResponseExpanded ¶ added in v1.19.0 

type SearchPastGrantsResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

SearchPastGrantsResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*SearchPastGrantsResponseExpanded) GetAdditionalProperties ¶ added in v1.19.0 

func (o *SearchPastGrantsResponseExpanded) GetAdditionalProperties() map[string]any

func (*SearchPastGrantsResponseExpanded) GetAtType ¶ added in v1.19.0 

func (o *SearchPastGrantsResponseExpanded) GetAtType() *string

func (SearchPastGrantsResponseExpanded) MarshalJSON ¶ added in v1.19.0 

func (s SearchPastGrantsResponseExpanded) MarshalJSON() ([]byte, error)

func (*SearchPastGrantsResponseExpanded) UnmarshalJSON ¶ added in v1.19.0 

func (s *SearchPastGrantsResponseExpanded) UnmarshalJSON(data []byte) error

type SearchPoliciesRequest ¶ added in v1.7.0 

type SearchPoliciesRequest struct {
	// Search for policies with a case insensitive match on the display name.
	DisplayName *string `json:"displayName,omitempty"`
	// The includeDeleted field.
	IncludeDeleted *bool `json:"includeDeleted,omitempty"`
	// The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)
	PageSize *int `json:"pageSize,omitempty"`
	// The pageToken field.
	PageToken *string `json:"pageToken,omitempty"`
	// The policy type to search on. This can be POLICY_TYPE_GRANT, POLICY_TYPE_REVOKE, POLICY_TYPE_CERTIFY, POLICY_TYPE_ACCESS_REQUEST, or POLICY_TYPE_PROVISION.
	PolicyTypes []PolicyTypes `json:"policyTypes,omitempty"`
	// Query the policies with a fuzzy search on display name and description.
	Query *string `json:"query,omitempty"`
	// The refs field.
	Refs []PolicyRef `json:"refs,omitempty"`
}

SearchPoliciesRequest - Search Policies by a few properties.

func (*SearchPoliciesRequest) GetDisplayName ¶ added in v1.7.0 

func (o *SearchPoliciesRequest) GetDisplayName() *string

func (*SearchPoliciesRequest) GetIncludeDeleted ¶ added in v1.18.3 

func (o *SearchPoliciesRequest) GetIncludeDeleted() *bool

func (*SearchPoliciesRequest) GetPageSize ¶ added in v1.7.0 

func (o *SearchPoliciesRequest) GetPageSize() *int

func (*SearchPoliciesRequest) GetPageToken ¶ added in v1.7.0 

func (o *SearchPoliciesRequest) GetPageToken() *string

func (*SearchPoliciesRequest) GetPolicyTypes ¶ added in v1.7.0 

func (o *SearchPoliciesRequest) GetPolicyTypes() []PolicyTypes

func (*SearchPoliciesRequest) GetQuery ¶ added in v1.7.0 

func (o *SearchPoliciesRequest) GetQuery() *string

func (*SearchPoliciesRequest) GetRefs ¶ added in v1.8.0 

func (o *SearchPoliciesRequest) GetRefs() []PolicyRef

type SearchUsersRequest ¶ added in v1.0.3 

type SearchUsersRequest struct {
	// The user expand mask is used to indicate which related objects should be expanded in the response.
	//  The supported paths are 'role_ids', 'manager_ids', 'delegated_user_id', 'directory_ids', and '*'.
	UserExpandMask *UserExpandMask `json:"expandMask,omitempty"`
	// Search for users based on their email (exact match).
	Email *string `json:"email,omitempty"`
	// An array of users IDs to exclude from the results.
	ExcludeIds []string `json:"excludeIds,omitempty"`
	// Deprecated. Use refs array instead.
	Ids []string `json:"ids,omitempty"`
	// The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)
	PageSize *int `json:"pageSize,omitempty"`
	// The pageToken field.
	PageToken *string `json:"pageToken,omitempty"`
	// Query the apps with a fuzzy search on display name and emails.
	Query *string `json:"query,omitempty"`
	// An array of user refs to restrict the return values to by ID.
	Refs []UserRef `json:"refs,omitempty"`
	// Search for users that have any of the role IDs on this list.
	RoleIds []string `json:"roleIds,omitempty"`
	// Search for users that have any of the statuses on this list. This can only be ENABLED, DISABLED, and DELETED
	UserStatuses []UserStatuses `json:"userStatuses,omitempty"`
}

SearchUsersRequest - Search for users based on some filters.

func (*SearchUsersRequest) GetEmail ¶ added in v1.7.0 

func (o *SearchUsersRequest) GetEmail() *string

func (*SearchUsersRequest) GetExcludeIds ¶ added in v1.6.1 

func (o *SearchUsersRequest) GetExcludeIds() []string

func (*SearchUsersRequest) GetIds ¶ added in v1.6.1 

func (o *SearchUsersRequest) GetIds() []string

func (*SearchUsersRequest) GetPageSize ¶ added in v1.6.1 

func (o *SearchUsersRequest) GetPageSize() *int

func (*SearchUsersRequest) GetPageToken ¶ added in v1.6.1 

func (o *SearchUsersRequest) GetPageToken() *string

func (*SearchUsersRequest) GetQuery ¶ added in v1.6.1 

func (o *SearchUsersRequest) GetQuery() *string

func (*SearchUsersRequest) GetRefs ¶ added in v1.6.1 

func (o *SearchUsersRequest) GetRefs() []UserRef

func (*SearchUsersRequest) GetRoleIds ¶ added in v1.6.1 

func (o *SearchUsersRequest) GetRoleIds() []string

func (*SearchUsersRequest) GetUserExpandMask ¶ added in v1.6.1 

func (o *SearchUsersRequest) GetUserExpandMask() *UserExpandMask

func (*SearchUsersRequest) GetUserStatuses ¶ added in v1.6.1 

func (o *SearchUsersRequest) GetUserStatuses() []UserStatuses

type SearchUsersResponse ¶ added in v1.0.3 

type SearchUsersResponse struct {
	// List of related objects
	Expanded []SearchUsersResponseExpanded `json:"expanded,omitempty"`
	// The list of results containing up to X results, where X is the page size defined in the request
	List []UserView `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The SearchUsersResponse message.

func (*SearchUsersResponse) GetExpanded ¶ added in v1.6.1 

func (o *SearchUsersResponse) GetExpanded() []SearchUsersResponseExpanded

func (*SearchUsersResponse) GetList ¶ added in v1.6.1 

func (o *SearchUsersResponse) GetList() []UserView

func (*SearchUsersResponse) GetNextPageToken ¶ added in v1.6.1 

func (o *SearchUsersResponse) GetNextPageToken() *string

type SearchUsersResponseExpanded ¶ added in v1.10.1 

type SearchUsersResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

SearchUsersResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*SearchUsersResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *SearchUsersResponseExpanded) GetAdditionalProperties() map[string]any

func (*SearchUsersResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *SearchUsersResponseExpanded) GetAtType() *string

func (SearchUsersResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (s SearchUsersResponseExpanded) MarshalJSON() ([]byte, error)

func (*SearchUsersResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (s *SearchUsersResponseExpanded) UnmarshalJSON(data []byte) error

type Security ¶ added in v1.7.0 

type Security struct {
	BearerAuth string `security:"scheme,type=http,subtype=bearer,name=Authorization"`
	Oauth      string `security:"scheme,type=oauth2,name=Authorization"`
}

func (*Security) GetBearerAuth ¶ added in v1.8.0 

func (o *Security) GetBearerAuth() string

func (*Security) GetOauth ¶ added in v1.7.0 

func (o *Security) GetOauth() string

type SelfApproval ¶ added in v1.0.3 

type SelfApproval struct {
	// The array of users determined to be themselves during approval. This should only ever be one person, but is saved because it may change if the owner of an app user changes while the ticket is open.
	AssignedUserIds []string `json:"assignedUserIds,omitempty"`
	// Configuration to allow a fallback if the identity user of the target app user cannot be determined.
	Fallback *bool `json:"fallback,omitempty"`
	// Configuration to specific which users to fallback to if fallback is enabled and the identity user of the target app user cannot be determined.
	FallbackUserIds []string `json:"fallbackUserIds,omitempty"`
}

SelfApproval - The self approval object describes the configuration of a policy step that needs to be approved by the target of the request.

func (*SelfApproval) GetAssignedUserIds ¶ added in v1.6.1 

func (o *SelfApproval) GetAssignedUserIds() []string

func (*SelfApproval) GetFallback ¶ added in v1.6.1 

func (o *SelfApproval) GetFallback() *bool

func (*SelfApproval) GetFallbackUserIds ¶ added in v1.6.1 

func (o *SelfApproval) GetFallbackUserIds() []string

type SessionSettings ¶ added in v1.16.0 

type SessionSettings struct {
	// The CIDRRestriction message.
	CIDRRestriction *CIDRRestriction `json:"connectorSource,omitempty"`
	// The CIDRRestriction message.
	CIDRRestriction1 *CIDRRestriction `json:"pccAdminSource,omitempty"`
	// The CIDRRestriction message.
	CIDRRestriction2 *CIDRRestriction `json:"pccUserSource,omitempty"`
	// The CIDRRestriction message.
	CIDRRestriction3 *CIDRRestriction `json:"ssoAdminSource,omitempty"`
	// The CIDRRestriction message.
	CIDRRestriction4 *CIDRRestriction `json:"ssoUserSource,omitempty"`
	MaxSessionLength *string          `json:"maxSessionLength,omitempty"`
}

The SessionSettings message.

func (*SessionSettings) GetCIDRRestriction ¶ added in v1.21.4 

func (o *SessionSettings) GetCIDRRestriction() *CIDRRestriction

func (*SessionSettings) GetCIDRRestriction1 ¶ added in v1.21.4 

func (o *SessionSettings) GetCIDRRestriction1() *CIDRRestriction

func (*SessionSettings) GetCIDRRestriction2 ¶ added in v1.21.4 

func (o *SessionSettings) GetCIDRRestriction2() *CIDRRestriction

func (*SessionSettings) GetCIDRRestriction3 ¶ added in v1.21.4 

func (o *SessionSettings) GetCIDRRestriction3() *CIDRRestriction

func (*SessionSettings) GetCIDRRestriction4 ¶ added in v1.21.4 

func (o *SessionSettings) GetCIDRRestriction4() *CIDRRestriction

func (*SessionSettings) GetMaxSessionLength ¶ added in v1.16.0 

func (o *SessionSettings) GetMaxSessionLength() *string

type SetAppEntitlementOwnersRequest ¶ added in v1.8.0 

type SetAppEntitlementOwnersRequest struct {
	// The user_ids field for the users to set as an owner of the app entitlement.
	UserIds []string `json:"userIds,omitempty"`
}

SetAppEntitlementOwnersRequest - The request message for setting the app entitlement owners.

func (*SetAppEntitlementOwnersRequest) GetUserIds ¶ added in v1.8.0 

func (o *SetAppEntitlementOwnersRequest) GetUserIds() []string

type SetAppEntitlementOwnersResponse ¶ added in v1.8.0 

type SetAppEntitlementOwnersResponse struct {
}

SetAppEntitlementOwnersResponse - The empty response message for setting the app entitlement owners.

type SetAppOwnersRequest ¶ added in v1.15.0 

type SetAppOwnersRequest struct {
	// The user_ids field for the users to set as an owner of the app.
	UserIds []string `json:"userIds,omitempty"`
}

SetAppOwnersRequest - The request message for setting the app owners.

func (*SetAppOwnersRequest) GetUserIds ¶ added in v1.15.0 

func (o *SetAppOwnersRequest) GetUserIds() []string

type SetAppOwnersResponse ¶ added in v1.15.0 

type SetAppOwnersResponse struct {
}

SetAppOwnersResponse - The empty response message for setting the app owners.

type SetBundleAutomationRequest ¶ added in v1.18.3 

type SetBundleAutomationRequest struct {
	// The BundleAutomationRuleEntitlement message.
	BundleAutomationRuleEntitlement *BundleAutomationRuleEntitlement `json:"entitlements,omitempty"`
	// The createTasks field.
	CreateTasks *bool `json:"createTasks,omitempty"`
	// The enabled field.
	Enabled *bool `json:"enabled,omitempty"`
}

The SetBundleAutomationRequest message.

This message contains a oneof named conditions. Only a single field of the following list may be set at a time:

  • entitlements

func (*SetBundleAutomationRequest) GetBundleAutomationRuleEntitlement ¶ added in v1.18.3 

func (o *SetBundleAutomationRequest) GetBundleAutomationRuleEntitlement() *BundleAutomationRuleEntitlement

func (*SetBundleAutomationRequest) GetCreateTasks ¶ added in v1.21.3 

func (o *SetBundleAutomationRequest) GetCreateTasks() *bool

func (*SetBundleAutomationRequest) GetEnabled ¶ added in v1.20.0 

func (o *SetBundleAutomationRequest) GetEnabled() *bool

type Severity ¶ added in v1.15.0 

type Severity string

Severity - The severity field. 

const (
	SeverityUnknown Severity = "UNKNOWN"
	SeverityHint    Severity = "HINT"
	SeverityInfo    Severity = "INFO"
	SeverityWarning Severity = "WARNING"
	SeverityError   Severity = "ERROR"
)

func (Severity) ToPointer ¶ added in v1.15.0 

func (e Severity) ToPointer() *Severity

type SortBy ¶ added in v1.15.0 

type SortBy string

SortBy - Sort tasks in a specific order. 

const (
	SortByTaskSearchSortByUnspecified     SortBy = "TASK_SEARCH_SORT_BY_UNSPECIFIED"
	SortByTaskSearchSortByAccount         SortBy = "TASK_SEARCH_SORT_BY_ACCOUNT"
	SortByTaskSearchSortByResource        SortBy = "TASK_SEARCH_SORT_BY_RESOURCE"
	SortByTaskSearchSortByAccountOwner    SortBy = "TASK_SEARCH_SORT_BY_ACCOUNT_OWNER"
	SortByTaskSearchSortByReverseTicketID SortBy = "TASK_SEARCH_SORT_BY_REVERSE_TICKET_ID"
)

func (SortBy) ToPointer ¶ added in v1.15.0 

func (e SortBy) ToPointer() *SortBy

type SortDirection ¶ added in v1.18.3 

type SortDirection string

SortDirection - The sortDirection field. 

const (
	SortDirectionSortDirectionUnspecified SortDirection = "SORT_DIRECTION_UNSPECIFIED"
	SortDirectionSortDirectionAsc         SortDirection = "SORT_DIRECTION_ASC"
	SortDirectionSortDirectionDesc        SortDirection = "SORT_DIRECTION_DESC"
)

func (SortDirection) ToPointer ¶ added in v1.18.3 

func (e SortDirection) ToPointer() *SortDirection

type State ¶ added in v1.15.0 

type State string

State - The last applied state of the app access request defaults. 

const (
	StateAppAccessRequestDefaultsLastApplyStateUnspecified   State = "APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_UNSPECIFIED"
	StateAppAccessRequestDefaultsLastApplyStateRunning       State = "APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_RUNNING"
	StateAppAccessRequestDefaultsLastApplyStateSuccess       State = "APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_SUCCESS"
	StateAppAccessRequestDefaultsLastApplyStateFailed        State = "APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_FAILED"
	StateAppAccessRequestDefaultsLastApplyStateCanceling     State = "APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_CANCELING"
	StateAppAccessRequestDefaultsLastApplyStateCancelSuccess State = "APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_CANCEL_SUCCESS"
	StateAppAccessRequestDefaultsLastApplyStateCancelError   State = "APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_CANCEL_ERROR"
)

func (State) ToPointer ¶ added in v1.15.0 

func (e State) ToPointer() *State

type Status ¶ added in v1.15.0 

type Status struct {
	// The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
	Code *int `json:"code,omitempty"`
	// A list of messages that carry the error details.  There is a common set of
	//  message types for APIs to use.
	Details []Details `json:"details,omitempty"`
	// A developer-facing error message, which should be in English. Any
	//  user-facing error message should be localized and sent in the
	//  [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
	Message *string `json:"message,omitempty"`
}

Status - The `Status` type defines a logical error model that is suitable for 

different programming environments, including REST APIs and RPC APIs. It is
used by [gRPC](https://github.com/grpc). Each `Status` message contains
three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the
[API Design Guide](https://cloud.google.com/apis/design/errors).

func (*Status) GetCode ¶ added in v1.21.4 

func (o *Status) GetCode() *int

func (*Status) GetDetails ¶ added in v1.21.4 

func (o *Status) GetDetails() []Details

func (*Status) GetMessage ¶ added in v1.21.4 

func (o *Status) GetMessage() *string

type SystemLogServiceListEventsRequest ¶ added in v1.18.3 

type SystemLogServiceListEventsRequest struct {
	// The pageSize field.
	PageSize *int `json:"pageSize,omitempty"`
	// The pageToken field.
	PageToken *string    `json:"pageToken,omitempty"`
	Since     *time.Time `json:"since,omitempty"`
	// The sinceEventUid field.
	SinceEventUID *string `json:"sinceEventUid,omitempty"`
	// The sortDirection field.
	SortDirection *SortDirection `json:"sortDirection,omitempty"`
	Until         *time.Time     `json:"until,omitempty"`
}

The SystemLogServiceListEventsRequest message.

func (*SystemLogServiceListEventsRequest) GetPageSize ¶ added in v1.18.3 

func (o *SystemLogServiceListEventsRequest) GetPageSize() *int

func (*SystemLogServiceListEventsRequest) GetPageToken ¶ added in v1.18.3 

func (o *SystemLogServiceListEventsRequest) GetPageToken() *string

func (*SystemLogServiceListEventsRequest) GetSince ¶ added in v1.18.3 

func (o *SystemLogServiceListEventsRequest) GetSince() *time.Time

func (*SystemLogServiceListEventsRequest) GetSinceEventUID ¶ added in v1.18.3 

func (o *SystemLogServiceListEventsRequest) GetSinceEventUID() *string

func (*SystemLogServiceListEventsRequest) GetSortDirection ¶ added in v1.18.3 

func (o *SystemLogServiceListEventsRequest) GetSortDirection() *SortDirection

func (*SystemLogServiceListEventsRequest) GetUntil ¶ added in v1.18.3 

func (o *SystemLogServiceListEventsRequest) GetUntil() *time.Time

func (SystemLogServiceListEventsRequest) MarshalJSON ¶ added in v1.18.3 

func (s SystemLogServiceListEventsRequest) MarshalJSON() ([]byte, error)

func (*SystemLogServiceListEventsRequest) UnmarshalJSON ¶ added in v1.18.3 

func (s *SystemLogServiceListEventsRequest) UnmarshalJSON(data []byte) error

type SystemLogServiceListEventsResponse ¶ added in v1.18.3 

type SystemLogServiceListEventsResponse struct {
	// List contains an array of JSON OCSF events.
	List []map[string]any `json:"list,omitempty"`
	// The nextPageToken field.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The SystemLogServiceListEventsResponse message.

func (*SystemLogServiceListEventsResponse) GetList ¶ added in v1.18.3 

func (o *SystemLogServiceListEventsResponse) GetList() []map[string]any

func (*SystemLogServiceListEventsResponse) GetNextPageToken ¶ added in v1.18.3 

func (o *SystemLogServiceListEventsResponse) GetNextPageToken() *string

type Task ¶ added in v1.0.3 

type Task struct {
	// A policy instance is an object that contains a reference to the policy it was created from, the currently executing step, the next steps, and the history of previously completed steps.
	PolicyInstance *PolicyInstance `json:"policy,omitempty"`
	// Task Type provides configuration for the type of task: certify, grant, or revoke
	//
	// This message contains a oneof named task_type. Only a single field of the following list may be set at a time:
	//   - grant
	//   - revoke
	//   - certify
	//   - offboarding
	//
	TaskType *TaskType `json:"type,omitempty"`
	// The actions that can be performed on the task by the current user.
	Actions []Actions `json:"actions,omitempty"`
	// The ID of the analysis object associated with this task created by an analysis workflow if the analysis feature is enabled for your tenant.
	AnalysisID *string `json:"analysisId,omitempty"`
	// An array of `google.protobuf.Any` annotations with various base64-encoded data.
	Annotations []Annotations `json:"annotations,omitempty"`
	// The count of comments.
	CommentCount *int       `json:"commentCount,omitempty"`
	CreatedAt    *time.Time `json:"createdAt,omitempty"`
	// The ID of the user that is the creator of this task. This may not always match the userId field.
	CreatedByUserID *string    `json:"createdByUserId,omitempty"`
	DeletedAt       *time.Time `json:"deletedAt,omitempty"`
	// The description of the task. This is also known as justification.
	Description *string `json:"description,omitempty"`
	// The display name of the task.
	DisplayName *string `json:"displayName,omitempty"`
	// A field indicating whether this task was created using an emergency access flow, or escalated to emergency access. On task creation, it will also use the app entitlement's emergency policy when possible.
	EmergencyAccess *bool `json:"emergencyAccess,omitempty"`
	// An array of external references to the task. Historically that has been items like Jira task IDs. This is currently unused, but may come back in the future for integrations.
	ExternalRefs []ExternalRef `json:"externalRefs,omitempty"`
	// The ID of the task.
	ID *string `json:"id,omitempty"`
	// The insightIds field.
	InsightIds []string `json:"insightIds,omitempty"`
	// A human-usable numeric ID of a task which can be included in place of the fully qualified task id in path parmeters (but not search queries).
	NumericID *int64 `integer:"string" json:"numericId,omitempty"`
	// The origin field.
	Origin *Origin `json:"origin,omitempty"`
	// The policy generation id refers to the current policy's generation ID. This is changed when the policy is changed on a task.
	PolicyGenerationID *string `json:"policyGenerationId,omitempty"`
	// The processing state of a task as defined by the `processing_enum`
	Processing *Processing `json:"processing,omitempty"`
	// The recommendation field.
	Recommendation *Recommendation `json:"recommendation,omitempty"`
	// The current state of the task as defined by the `state_enum`
	State *TaskState `json:"state,omitempty"`
	// An array of IDs belonging to Identity Users that are allowed to review this step in a task.
	StepApproverIds []string   `json:"stepApproverIds,omitempty"`
	UpdatedAt       *time.Time `json:"updatedAt,omitempty"`
	// The ID of the user that is the target of this task. This may be empty if we're targeting a specific app user that has no known identity user.
	UserID *string `json:"userId,omitempty"`
}

Task - A fully-fleged task object. Includes its policy, references to external apps, its type, its processing history, and more.

func (*Task) GetActions ¶ added in v1.6.1 

func (o *Task) GetActions() []Actions

func (*Task) GetAnalysisID ¶ added in v1.6.1 

func (o *Task) GetAnalysisID() *string

func (*Task) GetAnnotations ¶ added in v1.6.1 

func (o *Task) GetAnnotations() []Annotations

func (*Task) GetCommentCount ¶ added in v1.6.1 

func (o *Task) GetCommentCount() *int

func (*Task) GetCreatedAt ¶ added in v1.6.1 

func (o *Task) GetCreatedAt() *time.Time

func (*Task) GetCreatedByUserID ¶ added in v1.6.1 

func (o *Task) GetCreatedByUserID() *string

func (*Task) GetDeletedAt ¶ added in v1.6.1 

func (o *Task) GetDeletedAt() *time.Time

func (*Task) GetDescription ¶ added in v1.6.1 

func (o *Task) GetDescription() *string

func (*Task) GetDisplayName ¶ added in v1.6.1 

func (o *Task) GetDisplayName() *string

func (*Task) GetEmergencyAccess ¶ added in v1.6.1 

func (o *Task) GetEmergencyAccess() *bool

func (*Task) GetExternalRefs ¶ added in v1.6.1 

func (o *Task) GetExternalRefs() []ExternalRef

func (*Task) GetID ¶ added in v1.6.1 

func (o *Task) GetID() *string

func (*Task) GetInsightIds ¶ added in v1.15.0 

func (o *Task) GetInsightIds() []string

func (*Task) GetNumericID ¶ added in v1.6.1 

func (o *Task) GetNumericID() *int64

func (*Task) GetOrigin ¶ added in v1.21.4 

func (o *Task) GetOrigin() *Origin

func (*Task) GetPolicyGenerationID ¶ added in v1.8.0 

func (o *Task) GetPolicyGenerationID() *string

func (*Task) GetPolicyInstance ¶ added in v1.6.1 

func (o *Task) GetPolicyInstance() *PolicyInstance

func (*Task) GetProcessing ¶ added in v1.6.1 

func (o *Task) GetProcessing() *Processing

func (*Task) GetRecommendation ¶ added in v1.15.0 

func (o *Task) GetRecommendation() *Recommendation

func (*Task) GetState ¶ added in v1.6.1 

func (o *Task) GetState() *TaskState

func (*Task) GetStepApproverIds ¶ added in v1.6.1 

func (o *Task) GetStepApproverIds() []string

func (*Task) GetTaskType ¶ added in v1.6.1 

func (o *Task) GetTaskType() *TaskType

func (*Task) GetUpdatedAt ¶ added in v1.6.1 

func (o *Task) GetUpdatedAt() *time.Time

func (*Task) GetUserID ¶ added in v1.6.1 

func (o *Task) GetUserID() *string

func (Task) MarshalJSON ¶ added in v1.10.1 

func (t Task) MarshalJSON() ([]byte, error)

func (*Task) UnmarshalJSON ¶ added in v1.10.1 

func (t *Task) UnmarshalJSON(data []byte) error

type TaskActionsServiceApproveRequest ¶ added in v1.0.3 

type TaskActionsServiceApproveRequest struct {
	// The task expand mask is an array of strings that specifes the related objects the requester wishes to have returned when making a request where the expand mask is part of the input. Use '*' to view all possible responses.
	TaskExpandMask *TaskExpandMask `json:"expandMask,omitempty"`
	// The comment attached to the request.
	Comment *string `json:"comment,omitempty"`
	// The ID of the policy step on the given task to approve.
	PolicyStepID string `json:"policyStepId"`
}

The TaskActionsServiceApproveRequest object lets you approve a task.

func (*TaskActionsServiceApproveRequest) GetComment ¶ added in v1.6.1 

func (o *TaskActionsServiceApproveRequest) GetComment() *string

func (*TaskActionsServiceApproveRequest) GetPolicyStepID ¶ added in v1.6.1 

func (o *TaskActionsServiceApproveRequest) GetPolicyStepID() string

func (*TaskActionsServiceApproveRequest) GetTaskExpandMask ¶ added in v1.6.1 

func (o *TaskActionsServiceApproveRequest) GetTaskExpandMask() *TaskExpandMask

type TaskActionsServiceApproveResponse ¶ added in v1.0.3 

type TaskActionsServiceApproveResponse struct {
	// Contains a task and JSONPATH expressions that describe where in the expanded array related objects are located. This view can be used to display a fully-detailed dashboard of task information.
	TaskView *TaskView `json:"taskView,omitempty"`
	// List of serialized related objects.
	Expanded []TaskActionsServiceApproveResponseExpanded `json:"expanded,omitempty"`
	// The ID of the ticket (task) approve action created by this request.
	TicketActionID *string `json:"ticketActionId,omitempty"`
}

The TaskActionsServiceApproveResponse returns a task view with paths indicating the location of expanded items in the array.

func (*TaskActionsServiceApproveResponse) GetExpanded ¶ added in v1.6.1 

func (o *TaskActionsServiceApproveResponse) GetExpanded() []TaskActionsServiceApproveResponseExpanded

func (*TaskActionsServiceApproveResponse) GetTaskView ¶ added in v1.6.1 

func (o *TaskActionsServiceApproveResponse) GetTaskView() *TaskView

func (*TaskActionsServiceApproveResponse) GetTicketActionID ¶ added in v1.6.1 

func (o *TaskActionsServiceApproveResponse) GetTicketActionID() *string

type TaskActionsServiceApproveResponseExpanded ¶ added in v1.10.1 

type TaskActionsServiceApproveResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

TaskActionsServiceApproveResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*TaskActionsServiceApproveResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *TaskActionsServiceApproveResponseExpanded) GetAdditionalProperties() map[string]any

func (*TaskActionsServiceApproveResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *TaskActionsServiceApproveResponseExpanded) GetAtType() *string

func (TaskActionsServiceApproveResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (t TaskActionsServiceApproveResponseExpanded) MarshalJSON() ([]byte, error)

func (*TaskActionsServiceApproveResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (t *TaskActionsServiceApproveResponseExpanded) UnmarshalJSON(data []byte) error

type TaskActionsServiceCommentRequest ¶ added in v1.0.3 

type TaskActionsServiceCommentRequest struct {
	// The task expand mask is an array of strings that specifes the related objects the requester wishes to have returned when making a request where the expand mask is part of the input. Use '*' to view all possible responses.
	TaskExpandMask *TaskExpandMask `json:"expandMask,omitempty"`
	// The comment to be posted to the ticket
	Comment *string `json:"comment,omitempty"`
}

The TaskActionsServiceCommentRequest object lets you create a new comment on a task.

func (*TaskActionsServiceCommentRequest) GetComment ¶ added in v1.6.1 

func (o *TaskActionsServiceCommentRequest) GetComment() *string

func (*TaskActionsServiceCommentRequest) GetTaskExpandMask ¶ added in v1.6.1 

func (o *TaskActionsServiceCommentRequest) GetTaskExpandMask() *TaskExpandMask

type TaskActionsServiceCommentResponse ¶ added in v1.0.3 

type TaskActionsServiceCommentResponse struct {
	// Contains a task and JSONPATH expressions that describe where in the expanded array related objects are located. This view can be used to display a fully-detailed dashboard of task information.
	TaskView *TaskView `json:"taskView,omitempty"`
	// List of serialized related objects.
	Expanded []TaskActionsServiceCommentResponseExpanded `json:"expanded,omitempty"`
}

TaskActionsServiceCommentResponse - Task actions service comment response returns the task view inluding the expanded array of items that are indicated by the expand mask on the request.

func (*TaskActionsServiceCommentResponse) GetExpanded ¶ added in v1.6.1 

func (o *TaskActionsServiceCommentResponse) GetExpanded() []TaskActionsServiceCommentResponseExpanded

func (*TaskActionsServiceCommentResponse) GetTaskView ¶ added in v1.6.1 

func (o *TaskActionsServiceCommentResponse) GetTaskView() *TaskView

type TaskActionsServiceCommentResponseExpanded ¶ added in v1.10.1 

type TaskActionsServiceCommentResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

TaskActionsServiceCommentResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*TaskActionsServiceCommentResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *TaskActionsServiceCommentResponseExpanded) GetAdditionalProperties() map[string]any

func (*TaskActionsServiceCommentResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *TaskActionsServiceCommentResponseExpanded) GetAtType() *string

func (TaskActionsServiceCommentResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (t TaskActionsServiceCommentResponseExpanded) MarshalJSON() ([]byte, error)

func (*TaskActionsServiceCommentResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (t *TaskActionsServiceCommentResponseExpanded) UnmarshalJSON(data []byte) error

type TaskActionsServiceDenyRequest ¶ added in v1.0.3 

type TaskActionsServiceDenyRequest struct {
	// The task expand mask is an array of strings that specifes the related objects the requester wishes to have returned when making a request where the expand mask is part of the input. Use '*' to view all possible responses.
	TaskExpandMask *TaskExpandMask `json:"expandMask,omitempty"`
	// The comment attached to the request.
	Comment *string `json:"comment,omitempty"`
	// The ID of the currently policy step. This is the step you want to deny.
	PolicyStepID *string `json:"policyStepId,omitempty"`
}

The TaskActionsServiceDenyRequest object lets you deny a task.

func (*TaskActionsServiceDenyRequest) GetComment ¶ added in v1.6.1 

func (o *TaskActionsServiceDenyRequest) GetComment() *string

func (*TaskActionsServiceDenyRequest) GetPolicyStepID ¶ added in v1.6.1 

func (o *TaskActionsServiceDenyRequest) GetPolicyStepID() *string

func (*TaskActionsServiceDenyRequest) GetTaskExpandMask ¶ added in v1.6.1 

func (o *TaskActionsServiceDenyRequest) GetTaskExpandMask() *TaskExpandMask

type TaskActionsServiceDenyResponse ¶ added in v1.0.3 

type TaskActionsServiceDenyResponse struct {
	// Contains a task and JSONPATH expressions that describe where in the expanded array related objects are located. This view can be used to display a fully-detailed dashboard of task information.
	TaskView *TaskView `json:"taskView,omitempty"`
	// List of serialized related objects.
	Expanded []TaskActionsServiceDenyResponseExpanded `json:"expanded,omitempty"`
	// The ID of the ticket (task) deny action created by this request.
	TicketActionID *string `json:"ticketActionId,omitempty"`
}

The TaskActionsServiceDenyResponse returns a task view with paths indicating the location of expanded items in the array.

func (*TaskActionsServiceDenyResponse) GetExpanded ¶ added in v1.6.1 

func (o *TaskActionsServiceDenyResponse) GetExpanded() []TaskActionsServiceDenyResponseExpanded

func (*TaskActionsServiceDenyResponse) GetTaskView ¶ added in v1.6.1 

func (o *TaskActionsServiceDenyResponse) GetTaskView() *TaskView

func (*TaskActionsServiceDenyResponse) GetTicketActionID ¶ added in v1.6.1 

func (o *TaskActionsServiceDenyResponse) GetTicketActionID() *string

type TaskActionsServiceDenyResponseExpanded ¶ added in v1.10.1 

type TaskActionsServiceDenyResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

TaskActionsServiceDenyResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*TaskActionsServiceDenyResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *TaskActionsServiceDenyResponseExpanded) GetAdditionalProperties() map[string]any

func (*TaskActionsServiceDenyResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *TaskActionsServiceDenyResponseExpanded) GetAtType() *string

func (TaskActionsServiceDenyResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (t TaskActionsServiceDenyResponseExpanded) MarshalJSON() ([]byte, error)

func (*TaskActionsServiceDenyResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (t *TaskActionsServiceDenyResponseExpanded) UnmarshalJSON(data []byte) error

type TaskActionsServiceEscalateToEmergencyAccessRequest ¶ added in v1.7.0 

type TaskActionsServiceEscalateToEmergencyAccessRequest struct {
	// The task expand mask is an array of strings that specifes the related objects the requester wishes to have returned when making a request where the expand mask is part of the input. Use '*' to view all possible responses.
	TaskExpandMask *TaskExpandMask `json:"expandMask,omitempty"`
	// The comment field.
	Comment *string `json:"comment,omitempty"`
	// The policyStepId field.
	PolicyStepID *string `json:"policyStepId,omitempty"`
}

The TaskActionsServiceEscalateToEmergencyAccessRequest message.

func (*TaskActionsServiceEscalateToEmergencyAccessRequest) GetComment ¶ added in v1.7.0 

func (o *TaskActionsServiceEscalateToEmergencyAccessRequest) GetComment() *string

func (*TaskActionsServiceEscalateToEmergencyAccessRequest) GetPolicyStepID ¶ added in v1.7.0 

func (o *TaskActionsServiceEscalateToEmergencyAccessRequest) GetPolicyStepID() *string

func (*TaskActionsServiceEscalateToEmergencyAccessRequest) GetTaskExpandMask ¶ added in v1.7.0 

func (o *TaskActionsServiceEscalateToEmergencyAccessRequest) GetTaskExpandMask() *TaskExpandMask

type TaskActionsServiceHardResetRequest ¶ added in v1.20.0 

type TaskActionsServiceHardResetRequest struct {
	// The task expand mask is an array of strings that specifes the related objects the requester wishes to have returned when making a request where the expand mask is part of the input. Use '*' to view all possible responses.
	TaskExpandMask *TaskExpandMask `json:"expandMask,omitempty"`
	// The comment attached to the request.
	Comment *string `json:"comment,omitempty"`
}

The TaskActionsServiceHardResetRequest object lets you reset a task and recalculate its policy.

func (*TaskActionsServiceHardResetRequest) GetComment ¶ added in v1.20.0 

func (o *TaskActionsServiceHardResetRequest) GetComment() *string

func (*TaskActionsServiceHardResetRequest) GetTaskExpandMask ¶ added in v1.20.0 

func (o *TaskActionsServiceHardResetRequest) GetTaskExpandMask() *TaskExpandMask

type TaskActionsServiceHardResetResponse ¶ added in v1.20.0 

type TaskActionsServiceHardResetResponse struct {
	// Contains a task and JSONPATH expressions that describe where in the expanded array related objects are located. This view can be used to display a fully-detailed dashboard of task information.
	TaskView *TaskView `json:"taskView,omitempty"`
	// The expanded field.
	Expanded []TaskActionsServiceHardResetResponseExpanded `json:"expanded,omitempty"`
	// The ticketActionId field.
	TicketActionID *string `json:"ticketActionId,omitempty"`
}

The TaskActionsServiceHardResetResponse message.

func (*TaskActionsServiceHardResetResponse) GetExpanded ¶ added in v1.20.0 

func (o *TaskActionsServiceHardResetResponse) GetExpanded() []TaskActionsServiceHardResetResponseExpanded

func (*TaskActionsServiceHardResetResponse) GetTaskView ¶ added in v1.20.0 

func (o *TaskActionsServiceHardResetResponse) GetTaskView() *TaskView

func (*TaskActionsServiceHardResetResponse) GetTicketActionID ¶ added in v1.20.0 

func (o *TaskActionsServiceHardResetResponse) GetTicketActionID() *string

type TaskActionsServiceHardResetResponseExpanded ¶ added in v1.20.0 

type TaskActionsServiceHardResetResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

TaskActionsServiceHardResetResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*TaskActionsServiceHardResetResponseExpanded) GetAdditionalProperties ¶ added in v1.20.0 

func (o *TaskActionsServiceHardResetResponseExpanded) GetAdditionalProperties() map[string]any

func (*TaskActionsServiceHardResetResponseExpanded) GetAtType ¶ added in v1.20.0 

func (o *TaskActionsServiceHardResetResponseExpanded) GetAtType() *string

func (TaskActionsServiceHardResetResponseExpanded) MarshalJSON ¶ added in v1.20.0 

func (t TaskActionsServiceHardResetResponseExpanded) MarshalJSON() ([]byte, error)

func (*TaskActionsServiceHardResetResponseExpanded) UnmarshalJSON ¶ added in v1.20.0 

func (t *TaskActionsServiceHardResetResponseExpanded) UnmarshalJSON(data []byte) error

type TaskActionsServiceReassignRequest ¶ added in v1.18.3 

type TaskActionsServiceReassignRequest struct {
	// The task expand mask is an array of strings that specifes the related objects the requester wishes to have returned when making a request where the expand mask is part of the input. Use '*' to view all possible responses.
	TaskExpandMask *TaskExpandMask `json:"expandMask,omitempty"`
	// The comment field.
	Comment *string `json:"comment,omitempty"`
	// The newStepUserIds field.
	NewStepUserIds []string `json:"newStepUserIds,omitempty"`
	// The policyStepId field.
	PolicyStepID *string `json:"policyStepId,omitempty"`
}

The TaskActionsServiceReassignRequest message.

func (*TaskActionsServiceReassignRequest) GetComment ¶ added in v1.18.3 

func (o *TaskActionsServiceReassignRequest) GetComment() *string

func (*TaskActionsServiceReassignRequest) GetNewStepUserIds ¶ added in v1.18.3 

func (o *TaskActionsServiceReassignRequest) GetNewStepUserIds() []string

func (*TaskActionsServiceReassignRequest) GetPolicyStepID ¶ added in v1.18.3 

func (o *TaskActionsServiceReassignRequest) GetPolicyStepID() *string

func (*TaskActionsServiceReassignRequest) GetTaskExpandMask ¶ added in v1.18.3 

func (o *TaskActionsServiceReassignRequest) GetTaskExpandMask() *TaskExpandMask

type TaskActionsServiceReassignResponse ¶ added in v1.18.3 

type TaskActionsServiceReassignResponse struct {
	// Contains a task and JSONPATH expressions that describe where in the expanded array related objects are located. This view can be used to display a fully-detailed dashboard of task information.
	TaskView *TaskView `json:"taskView,omitempty"`
	// List of serialized related objects.
	Expanded []TaskActionsServiceReassignResponseExpanded `json:"expanded,omitempty"`
	// The ID of the ticket (task) deny action created by this request.
	TicketActionID *string `json:"ticketActionId,omitempty"`
}

The TaskActionsServiceReassignResponse returns a task view with paths indicating the location of expanded items in the array.

func (*TaskActionsServiceReassignResponse) GetExpanded ¶ added in v1.18.3 

func (o *TaskActionsServiceReassignResponse) GetExpanded() []TaskActionsServiceReassignResponseExpanded

func (*TaskActionsServiceReassignResponse) GetTaskView ¶ added in v1.18.3 

func (o *TaskActionsServiceReassignResponse) GetTaskView() *TaskView

func (*TaskActionsServiceReassignResponse) GetTicketActionID ¶ added in v1.18.3 

func (o *TaskActionsServiceReassignResponse) GetTicketActionID() *string

type TaskActionsServiceReassignResponseExpanded ¶ added in v1.18.3 

type TaskActionsServiceReassignResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

TaskActionsServiceReassignResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*TaskActionsServiceReassignResponseExpanded) GetAdditionalProperties ¶ added in v1.18.3 

func (o *TaskActionsServiceReassignResponseExpanded) GetAdditionalProperties() map[string]any

func (*TaskActionsServiceReassignResponseExpanded) GetAtType ¶ added in v1.18.3 

func (o *TaskActionsServiceReassignResponseExpanded) GetAtType() *string

func (TaskActionsServiceReassignResponseExpanded) MarshalJSON ¶ added in v1.18.3 

func (t TaskActionsServiceReassignResponseExpanded) MarshalJSON() ([]byte, error)

func (*TaskActionsServiceReassignResponseExpanded) UnmarshalJSON ¶ added in v1.18.3 

func (t *TaskActionsServiceReassignResponseExpanded) UnmarshalJSON(data []byte) error

type TaskActionsServiceRestartRequest ¶ added in v1.15.0 

type TaskActionsServiceRestartRequest struct {
	// The task expand mask is an array of strings that specifes the related objects the requester wishes to have returned when making a request where the expand mask is part of the input. Use '*' to view all possible responses.
	TaskExpandMask *TaskExpandMask `json:"expandMask,omitempty"`
	// The comment attached to the request.
	Comment *string `json:"comment,omitempty"`
	// The ID of the policy step on the given task to restart.
	PolicyStepID *string `json:"policyStepId,omitempty"`
}

The TaskActionsServiceRestartRequest object lets you restart a task.

func (*TaskActionsServiceRestartRequest) GetComment ¶ added in v1.15.0 

func (o *TaskActionsServiceRestartRequest) GetComment() *string

func (*TaskActionsServiceRestartRequest) GetPolicyStepID ¶ added in v1.15.0 

func (o *TaskActionsServiceRestartRequest) GetPolicyStepID() *string

func (*TaskActionsServiceRestartRequest) GetTaskExpandMask ¶ added in v1.15.0 

func (o *TaskActionsServiceRestartRequest) GetTaskExpandMask() *TaskExpandMask

type TaskActionsServiceRestartResponse ¶ added in v1.15.0 

type TaskActionsServiceRestartResponse struct {
	// Contains a task and JSONPATH expressions that describe where in the expanded array related objects are located. This view can be used to display a fully-detailed dashboard of task information.
	TaskView *TaskView `json:"taskView,omitempty"`
	// The expanded field.
	Expanded []TaskActionsServiceRestartResponseExpanded `json:"expanded,omitempty"`
	// The ticketActionId field.
	TicketActionID *string `json:"ticketActionId,omitempty"`
}

The TaskActionsServiceRestartResponse message.

func (*TaskActionsServiceRestartResponse) GetExpanded ¶ added in v1.15.0 

func (o *TaskActionsServiceRestartResponse) GetExpanded() []TaskActionsServiceRestartResponseExpanded

func (*TaskActionsServiceRestartResponse) GetTaskView ¶ added in v1.15.0 

func (o *TaskActionsServiceRestartResponse) GetTaskView() *TaskView

func (*TaskActionsServiceRestartResponse) GetTicketActionID ¶ added in v1.15.0 

func (o *TaskActionsServiceRestartResponse) GetTicketActionID() *string

type TaskActionsServiceRestartResponseExpanded ¶ added in v1.15.0 

type TaskActionsServiceRestartResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

TaskActionsServiceRestartResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*TaskActionsServiceRestartResponseExpanded) GetAdditionalProperties ¶ added in v1.15.0 

func (o *TaskActionsServiceRestartResponseExpanded) GetAdditionalProperties() map[string]any

func (*TaskActionsServiceRestartResponseExpanded) GetAtType ¶ added in v1.15.0 

func (o *TaskActionsServiceRestartResponseExpanded) GetAtType() *string

func (TaskActionsServiceRestartResponseExpanded) MarshalJSON ¶ added in v1.15.0 

func (t TaskActionsServiceRestartResponseExpanded) MarshalJSON() ([]byte, error)

func (*TaskActionsServiceRestartResponseExpanded) UnmarshalJSON ¶ added in v1.15.0 

func (t *TaskActionsServiceRestartResponseExpanded) UnmarshalJSON(data []byte) error

type TaskExpandMask ¶ added in v1.0.3 

type TaskExpandMask struct {
	// A list of paths to expand in the response. May be any combination of "*", "access_review_id", "user_id", "created_by_user_id", "app_id", "app_user_id", "app_entitlement_ids", "step_approver_ids", "identity_user_id", and "insight_ids".
	Paths []string `json:"paths,omitempty"`
}

TaskExpandMask - The task expand mask is an array of strings that specifes the related objects the requester wishes to have returned when making a request where the expand mask is part of the input. Use '*' to view all possible responses.

func (*TaskExpandMask) GetPaths ¶ added in v1.6.1 

func (o *TaskExpandMask) GetPaths() []string

type TaskGrantSource ¶ added in v1.8.0 

type TaskGrantSource struct {
	// The external url source of the grant ticket.
	ExternalURL *string `json:"externalUrl,omitempty"`
	// The integration id for the source of tickets.
	IntegrationID *string `json:"integrationId,omitempty"`
	// the request id for the grant ticket if the source is external
	RequestID *string `json:"requestId,omitempty"`
}

The TaskGrantSource message tracks which external URL was the source of the specificed grant ticket.

func (*TaskGrantSource) GetExternalURL ¶ added in v1.8.0 

func (o *TaskGrantSource) GetExternalURL() *string

func (*TaskGrantSource) GetIntegrationID ¶ added in v1.8.0 

func (o *TaskGrantSource) GetIntegrationID() *string

func (*TaskGrantSource) GetRequestID ¶ added in v1.18.3 

func (o *TaskGrantSource) GetRequestID() *string

type TaskRef ¶ added in v1.0.3 

type TaskRef struct {
	// The ID of the referenced Task
	ID *string `json:"id,omitempty"`
}

TaskRef - This object references a task by ID.

func (*TaskRef) GetID ¶ added in v1.6.1 

func (o *TaskRef) GetID() *string

type TaskRevokeSource ¶ added in v1.0.3 

type TaskRevokeSource struct {
	// The TaskRevokeSourceExpired message indicates that the source of the revoke task is due to a grant expiring.
	TaskRevokeSourceExpired *TaskRevokeSourceExpired `json:"expired,omitempty"`
	// The TaskRevokeSourceNonUsage message indicates that the source of the revoke task is due to the grant not being used.
	TaskRevokeSourceNonUsage *TaskRevokeSourceNonUsage `json:"nonUsage,omitempty"`
	// The TaskRevokeSourceRequest message indicates that the source of the revoke task was a request.
	TaskRevokeSourceRequest *TaskRevokeSourceRequest `json:"request,omitempty"`
	// The TaskRevokeSourceReview message tracks which access review was the source of the specificed revoke ticket.
	TaskRevokeSourceReview *TaskRevokeSourceReview `json:"review,omitempty"`
}

The TaskRevokeSource message indicates the source of the revoke task is one of expired, nonUsage, request, or review.

This message contains a oneof named origin. Only a single field of the following list may be set at a time:

  • review
  • request
  • expired
  • nonUsage

func (*TaskRevokeSource) GetTaskRevokeSourceExpired ¶ added in v1.6.1 

func (o *TaskRevokeSource) GetTaskRevokeSourceExpired() *TaskRevokeSourceExpired

func (*TaskRevokeSource) GetTaskRevokeSourceNonUsage ¶ added in v1.6.1 

func (o *TaskRevokeSource) GetTaskRevokeSourceNonUsage() *TaskRevokeSourceNonUsage

func (*TaskRevokeSource) GetTaskRevokeSourceRequest ¶ added in v1.6.1 

func (o *TaskRevokeSource) GetTaskRevokeSourceRequest() *TaskRevokeSourceRequest

func (*TaskRevokeSource) GetTaskRevokeSourceReview ¶ added in v1.6.1 

func (o *TaskRevokeSource) GetTaskRevokeSourceReview() *TaskRevokeSourceReview

type TaskRevokeSourceExpired ¶ added in v1.0.3 

type TaskRevokeSourceExpired struct {
	ExpiredAt *time.Time `json:"expiredAt,omitempty"`
}

The TaskRevokeSourceExpired message indicates that the source of the revoke task is due to a grant expiring.

func (*TaskRevokeSourceExpired) GetExpiredAt ¶ added in v1.6.1 

func (o *TaskRevokeSourceExpired) GetExpiredAt() *time.Time

func (TaskRevokeSourceExpired) MarshalJSON ¶ added in v1.10.1 

func (t TaskRevokeSourceExpired) MarshalJSON() ([]byte, error)

func (*TaskRevokeSourceExpired) UnmarshalJSON ¶ added in v1.10.1 

func (t *TaskRevokeSourceExpired) UnmarshalJSON(data []byte) error

type TaskRevokeSourceNonUsage ¶ added in v1.0.3 

type TaskRevokeSourceNonUsage struct {
	ExpiresAt *time.Time `json:"expiresAt,omitempty"`
	LastLogin *time.Time `json:"lastLogin,omitempty"`
}

The TaskRevokeSourceNonUsage message indicates that the source of the revoke task is due to the grant not being used.

func (*TaskRevokeSourceNonUsage) GetExpiresAt ¶ added in v1.6.1 

func (o *TaskRevokeSourceNonUsage) GetExpiresAt() *time.Time

func (*TaskRevokeSourceNonUsage) GetLastLogin ¶ added in v1.6.1 

func (o *TaskRevokeSourceNonUsage) GetLastLogin() *time.Time

func (TaskRevokeSourceNonUsage) MarshalJSON ¶ added in v1.10.1 

func (t TaskRevokeSourceNonUsage) MarshalJSON() ([]byte, error)

func (*TaskRevokeSourceNonUsage) UnmarshalJSON ¶ added in v1.10.1 

func (t *TaskRevokeSourceNonUsage) UnmarshalJSON(data []byte) error

type TaskRevokeSourceRequest ¶ added in v1.0.3 

type TaskRevokeSourceRequest struct {
	// The ID of the user who initiated the revoke request.
	RequestUserID *string `json:"requestUserId,omitempty"`
}

The TaskRevokeSourceRequest message indicates that the source of the revoke task was a request.

func (*TaskRevokeSourceRequest) GetRequestUserID ¶ added in v1.6.1 

func (o *TaskRevokeSourceRequest) GetRequestUserID() *string

type TaskRevokeSourceReview ¶ added in v1.0.3 

type TaskRevokeSourceReview struct {
	// The ID of the access review associated with the revoke task.
	AccessReviewID *string `json:"accessReviewId,omitempty"`
	// The ID of the certify ticket that was denied and created this revoke task.
	CertTicketID *string `json:"certTicketId,omitempty"`
}

The TaskRevokeSourceReview message tracks which access review was the source of the specificed revoke ticket.

func (*TaskRevokeSourceReview) GetAccessReviewID ¶ added in v1.6.1 

func (o *TaskRevokeSourceReview) GetAccessReviewID() *string

func (*TaskRevokeSourceReview) GetCertTicketID ¶ added in v1.6.1 

func (o *TaskRevokeSourceReview) GetCertTicketID() *string

type TaskSearchRequest ¶ added in v1.0.3 

type TaskSearchRequest struct {
	// The task expand mask is an array of strings that specifes the related objects the requester wishes to have returned when making a request where the expand mask is part of the input. Use '*' to view all possible responses.
	TaskExpandMask *TaskExpandMask `json:"expandMask,omitempty"`
	// Search tasks that belong to any of the access reviews included in this list.
	AccessReviewIds []string `json:"accessReviewIds,omitempty"`
	// Search tasks that have any of these account owners.
	AccountOwnerIds []string `json:"accountOwnerIds,omitempty"`
	// The accountTypes field.
	AccountTypes []AccountTypes `json:"accountTypes,omitempty"`
	// Search tasks that have this actor ID.
	ActorID *string `json:"actorId,omitempty"`
	// Search tasks that have any of these app entitlement IDs.
	AppEntitlementIds []string `json:"appEntitlementIds,omitempty"`
	// Search tasks that have any of these app resource IDs.
	AppResourceIds []string `json:"appResourceIds,omitempty"`
	// Search tasks that have any of these app resource type IDs.
	AppResourceTypeIds []string `json:"appResourceTypeIds,omitempty"`
	// Search tasks that have any of these app users as subjects.
	AppUserSubjectIds []string `json:"appUserSubjectIds,omitempty"`
	// Search tasks that have any of these apps as targets.
	ApplicationIds []string `json:"applicationIds,omitempty"`
	// Search tasks by  List of UserIDs which are currently assigned these Tasks
	AssigneesInIds []string   `json:"assigneesInIds,omitempty"`
	CreatedAfter   *time.Time `json:"createdAfter,omitempty"`
	CreatedBefore  *time.Time `json:"createdBefore,omitempty"`
	// Search tasks that have this type of step as the current step.
	CurrentStep *CurrentStep `json:"currentStep,omitempty"`
	// Search tasks that are or are not emergency access.
	EmergencyStatus *EmergencyStatus `json:"emergencyStatus,omitempty"`
	// Search tasks that do not have any of these app entitlement IDs.
	ExcludeAppEntitlementIds []string `json:"excludeAppEntitlementIds,omitempty"`
	// Search tasks that do not have any of these app resource type IDs.
	ExcludeAppResourceTypeIds []string `json:"excludeAppResourceTypeIds,omitempty"`
	// Exclude Specific TaskIDs from this serach result.
	ExcludeIds []string `json:"excludeIds,omitempty"`
	// Whether or not to include deleted tasks.
	IncludeDeleted *bool `json:"includeDeleted,omitempty"`
	// Search tasks where the user would see this task in the My Work section
	MyWorkUserIds     []string `json:"myWorkUserIds,omitempty"`
	OlderThanDuration *string  `json:"olderThanDuration,omitempty"`
	// Search tasks that were created by any of the users in this array.
	OpenerIds []string `json:"openerIds,omitempty"`
	// The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)
	PageSize *int `json:"pageSize,omitempty"`
	// The pageToken field.
	PageToken *string `json:"pageToken,omitempty"`
	// Search tasks that were acted on by any of these users.
	PreviouslyActedOnIds []string `json:"previouslyActedOnIds,omitempty"`
	// Fuzzy search tasks by display name or description. Also can search by numeric ID.
	Query *string `json:"query,omitempty"`
	// Query tasks by display name, description, or numeric ID.
	Refs []TaskRef `json:"refs,omitempty"`
	// Sort tasks in a specific order.
	SortBy *SortBy `json:"sortBy,omitempty"`
	// Search tasks where these users are the subject.
	SubjectIds []string `json:"subjectIds,omitempty"`
	// Search tasks with this task state.
	TaskStates []TaskStates `json:"taskStates,omitempty"`
	// Search tasks with this task type. This is a oneOf, and needs an object, which can be empty, to sort.
	TaskTypes []TaskTypeInput `json:"taskTypes,omitempty"`
}

TaskSearchRequest - Search for tasks based on a plethora filters.

func (*TaskSearchRequest) GetAccessReviewIds ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetAccessReviewIds() []string

func (*TaskSearchRequest) GetAccountOwnerIds ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetAccountOwnerIds() []string

func (*TaskSearchRequest) GetAccountTypes ¶ added in v1.18.3 

func (o *TaskSearchRequest) GetAccountTypes() []AccountTypes

func (*TaskSearchRequest) GetActorID ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetActorID() *string

func (*TaskSearchRequest) GetAppEntitlementIds ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetAppEntitlementIds() []string

func (*TaskSearchRequest) GetAppResourceIds ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetAppResourceIds() []string

func (*TaskSearchRequest) GetAppResourceTypeIds ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetAppResourceTypeIds() []string

func (*TaskSearchRequest) GetAppUserSubjectIds ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetAppUserSubjectIds() []string

func (*TaskSearchRequest) GetApplicationIds ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetApplicationIds() []string

func (*TaskSearchRequest) GetAssigneesInIds ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetAssigneesInIds() []string

func (*TaskSearchRequest) GetCreatedAfter ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetCreatedAfter() *time.Time

func (*TaskSearchRequest) GetCreatedBefore ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetCreatedBefore() *time.Time

func (*TaskSearchRequest) GetCurrentStep ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetCurrentStep() *CurrentStep

func (*TaskSearchRequest) GetEmergencyStatus ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetEmergencyStatus() *EmergencyStatus

func (*TaskSearchRequest) GetExcludeAppEntitlementIds ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetExcludeAppEntitlementIds() []string

func (*TaskSearchRequest) GetExcludeAppResourceTypeIds ¶ added in v1.21.4 

func (o *TaskSearchRequest) GetExcludeAppResourceTypeIds() []string

func (*TaskSearchRequest) GetExcludeIds ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetExcludeIds() []string

func (*TaskSearchRequest) GetIncludeDeleted ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetIncludeDeleted() *bool

func (*TaskSearchRequest) GetMyWorkUserIds ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetMyWorkUserIds() []string

func (*TaskSearchRequest) GetOlderThanDuration ¶ added in v1.18.3 

func (o *TaskSearchRequest) GetOlderThanDuration() *string

func (*TaskSearchRequest) GetOpenerIds ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetOpenerIds() []string

func (*TaskSearchRequest) GetPageSize ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetPageSize() *int

func (*TaskSearchRequest) GetPageToken ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetPageToken() *string

func (*TaskSearchRequest) GetPreviouslyActedOnIds ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetPreviouslyActedOnIds() []string

func (*TaskSearchRequest) GetQuery ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetQuery() *string

func (*TaskSearchRequest) GetRefs ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetRefs() []TaskRef

func (*TaskSearchRequest) GetSortBy ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetSortBy() *SortBy

func (*TaskSearchRequest) GetSubjectIds ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetSubjectIds() []string

func (*TaskSearchRequest) GetTaskExpandMask ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetTaskExpandMask() *TaskExpandMask

func (*TaskSearchRequest) GetTaskStates ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetTaskStates() []TaskStates

func (*TaskSearchRequest) GetTaskTypes ¶ added in v1.6.1 

func (o *TaskSearchRequest) GetTaskTypes() []TaskTypeInput

func (TaskSearchRequest) MarshalJSON ¶ added in v1.15.0 

func (t TaskSearchRequest) MarshalJSON() ([]byte, error)

func (*TaskSearchRequest) UnmarshalJSON ¶ added in v1.15.0 

func (t *TaskSearchRequest) UnmarshalJSON(data []byte) error

type TaskSearchResponse ¶ added in v1.0.3 

type TaskSearchResponse struct {
	// The list of results containing up to X results, where X is the page size defined in the request.
	Expanded []TaskSearchResponseExpanded `json:"expanded,omitempty"`
	// List of serialized related objects.
	List []TaskView `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retreived.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The TaskSearchResponse message contains a list of results and a nextPageToken if applicable.

func (*TaskSearchResponse) GetExpanded ¶ added in v1.6.1 

func (o *TaskSearchResponse) GetExpanded() []TaskSearchResponseExpanded

func (*TaskSearchResponse) GetList ¶ added in v1.6.1 

func (o *TaskSearchResponse) GetList() []TaskView

func (*TaskSearchResponse) GetNextPageToken ¶ added in v1.6.1 

func (o *TaskSearchResponse) GetNextPageToken() *string

type TaskSearchResponseExpanded ¶ added in v1.10.1 

type TaskSearchResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

TaskSearchResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*TaskSearchResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *TaskSearchResponseExpanded) GetAdditionalProperties() map[string]any

func (*TaskSearchResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *TaskSearchResponseExpanded) GetAtType() *string

func (TaskSearchResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (t TaskSearchResponseExpanded) MarshalJSON() ([]byte, error)

func (*TaskSearchResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (t *TaskSearchResponseExpanded) UnmarshalJSON(data []byte) error

type TaskServiceActionResponse ¶ added in v1.7.0 

type TaskServiceActionResponse struct {
	// Contains a task and JSONPATH expressions that describe where in the expanded array related objects are located. This view can be used to display a fully-detailed dashboard of task information.
	TaskView *TaskView `json:"taskView,omitempty"`
	// The expanded field.
	Expanded []TaskServiceActionResponseExpanded `json:"expanded,omitempty"`
	// The ticketActionId field.
	TicketActionID *string `json:"ticketActionId,omitempty"`
}

The TaskServiceActionResponse message.

func (*TaskServiceActionResponse) GetExpanded ¶ added in v1.7.0 

func (o *TaskServiceActionResponse) GetExpanded() []TaskServiceActionResponseExpanded

func (*TaskServiceActionResponse) GetTaskView ¶ added in v1.7.0 

func (o *TaskServiceActionResponse) GetTaskView() *TaskView

func (*TaskServiceActionResponse) GetTicketActionID ¶ added in v1.7.0 

func (o *TaskServiceActionResponse) GetTicketActionID() *string

type TaskServiceActionResponseExpanded ¶ added in v1.10.1 

type TaskServiceActionResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

TaskServiceActionResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*TaskServiceActionResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *TaskServiceActionResponseExpanded) GetAdditionalProperties() map[string]any

func (*TaskServiceActionResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *TaskServiceActionResponseExpanded) GetAtType() *string

func (TaskServiceActionResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (t TaskServiceActionResponseExpanded) MarshalJSON() ([]byte, error)

func (*TaskServiceActionResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (t *TaskServiceActionResponseExpanded) UnmarshalJSON(data []byte) error

type TaskServiceCreateGrantRequest ¶ added in v1.0.3 

type TaskServiceCreateGrantRequest struct {
	// The task expand mask is an array of strings that specifes the related objects the requester wishes to have returned when making a request where the expand mask is part of the input. Use '*' to view all possible responses.
	TaskExpandMask *TaskExpandMask `json:"expandMask,omitempty"`
	// The TaskGrantSource message tracks which external URL was the source of the specificed grant ticket.
	TaskGrantSource *TaskGrantSource `json:"source,omitempty"`
	// The ID of the app entitlement to grant access to.
	AppEntitlementID string `json:"appEntitlementId"`
	// The ID of the app that is associated with the entitlement.
	AppID string `json:"appId"`
	// The ID of the app user to grant access for. This field and identityUserId cannot both be set for a given request.
	AppUserID *string `json:"appUserId,omitempty"`
	// The description of the request.
	Description *string `json:"description,omitempty"`
	// Boolean stating whether or not the task is marked as emergency access.
	EmergencyAccess *bool   `json:"emergencyAccess,omitempty"`
	GrantDuration   *string `json:"grantDuration,omitempty"`
	// The ID of the user associated with the app user we are granting access for. This field cannot be set if appUserID is also set.
	IdentityUserID *string `json:"identityUserId,omitempty"`
}

TaskServiceCreateGrantRequest - Create a grant task.

func (*TaskServiceCreateGrantRequest) GetAppEntitlementID ¶ added in v1.6.1 

func (o *TaskServiceCreateGrantRequest) GetAppEntitlementID() string

func (*TaskServiceCreateGrantRequest) GetAppID ¶ added in v1.6.1 

func (o *TaskServiceCreateGrantRequest) GetAppID() string

func (*TaskServiceCreateGrantRequest) GetAppUserID ¶ added in v1.6.1 

func (o *TaskServiceCreateGrantRequest) GetAppUserID() *string

func (*TaskServiceCreateGrantRequest) GetDescription ¶ added in v1.6.1 

func (o *TaskServiceCreateGrantRequest) GetDescription() *string

func (*TaskServiceCreateGrantRequest) GetEmergencyAccess ¶ added in v1.6.1 

func (o *TaskServiceCreateGrantRequest) GetEmergencyAccess() *bool

func (*TaskServiceCreateGrantRequest) GetGrantDuration ¶ added in v1.6.1 

func (o *TaskServiceCreateGrantRequest) GetGrantDuration() *string

func (*TaskServiceCreateGrantRequest) GetIdentityUserID ¶ added in v1.6.1 

func (o *TaskServiceCreateGrantRequest) GetIdentityUserID() *string

func (*TaskServiceCreateGrantRequest) GetTaskExpandMask ¶ added in v1.6.1 

func (o *TaskServiceCreateGrantRequest) GetTaskExpandMask() *TaskExpandMask

func (*TaskServiceCreateGrantRequest) GetTaskGrantSource ¶ added in v1.8.0 

func (o *TaskServiceCreateGrantRequest) GetTaskGrantSource() *TaskGrantSource

type TaskServiceCreateGrantResponse ¶ added in v1.0.3 

type TaskServiceCreateGrantResponse struct {
	// Contains a task and JSONPATH expressions that describe where in the expanded array related objects are located. This view can be used to display a fully-detailed dashboard of task information.
	TaskView *TaskView `json:"taskView,omitempty"`
	// List of serialized related objects.
	Expanded []TaskServiceCreateGrantResponseExpanded `json:"expanded,omitempty"`
}

The TaskServiceCreateGrantResponse returns a task view which has a task including JSONPATHs to the expanded items in the expanded array.

func (*TaskServiceCreateGrantResponse) GetExpanded ¶ added in v1.6.1 

func (o *TaskServiceCreateGrantResponse) GetExpanded() []TaskServiceCreateGrantResponseExpanded

func (*TaskServiceCreateGrantResponse) GetTaskView ¶ added in v1.6.1 

func (o *TaskServiceCreateGrantResponse) GetTaskView() *TaskView

type TaskServiceCreateGrantResponseExpanded ¶ added in v1.10.1 

type TaskServiceCreateGrantResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

TaskServiceCreateGrantResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*TaskServiceCreateGrantResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *TaskServiceCreateGrantResponseExpanded) GetAdditionalProperties() map[string]any

func (*TaskServiceCreateGrantResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *TaskServiceCreateGrantResponseExpanded) GetAtType() *string

func (TaskServiceCreateGrantResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (t TaskServiceCreateGrantResponseExpanded) MarshalJSON() ([]byte, error)

func (*TaskServiceCreateGrantResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (t *TaskServiceCreateGrantResponseExpanded) UnmarshalJSON(data []byte) error

type TaskServiceCreateOffboardingRequest ¶ added in v1.18.3 

type TaskServiceCreateOffboardingRequest struct {
	// The task expand mask is an array of strings that specifes the related objects the requester wishes to have returned when making a request where the expand mask is part of the input. Use '*' to view all possible responses.
	TaskExpandMask *TaskExpandMask `json:"expandMask,omitempty"`
	// The description field.
	Description *string `json:"description,omitempty"`
	// The subjectUserId field.
	SubjectUserID *string `json:"subjectUserId,omitempty"`
}

The TaskServiceCreateOffboardingRequest message.

func (*TaskServiceCreateOffboardingRequest) GetDescription ¶ added in v1.18.3 

func (o *TaskServiceCreateOffboardingRequest) GetDescription() *string

func (*TaskServiceCreateOffboardingRequest) GetSubjectUserID ¶ added in v1.18.3 

func (o *TaskServiceCreateOffboardingRequest) GetSubjectUserID() *string

func (*TaskServiceCreateOffboardingRequest) GetTaskExpandMask ¶ added in v1.18.3 

func (o *TaskServiceCreateOffboardingRequest) GetTaskExpandMask() *TaskExpandMask

type TaskServiceCreateOffboardingResponse ¶ added in v1.18.3 

type TaskServiceCreateOffboardingResponse struct {
	// Contains a task and JSONPATH expressions that describe where in the expanded array related objects are located. This view can be used to display a fully-detailed dashboard of task information.
	TaskView *TaskView `json:"taskView,omitempty"`
	// The expanded field.
	Expanded []TaskServiceCreateOffboardingResponseExpanded `json:"expanded,omitempty"`
}

The TaskServiceCreateOffboardingResponse message.

func (*TaskServiceCreateOffboardingResponse) GetExpanded ¶ added in v1.18.3 

func (o *TaskServiceCreateOffboardingResponse) GetExpanded() []TaskServiceCreateOffboardingResponseExpanded

func (*TaskServiceCreateOffboardingResponse) GetTaskView ¶ added in v1.18.3 

func (o *TaskServiceCreateOffboardingResponse) GetTaskView() *TaskView

type TaskServiceCreateOffboardingResponseExpanded ¶ added in v1.18.3 

type TaskServiceCreateOffboardingResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

TaskServiceCreateOffboardingResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*TaskServiceCreateOffboardingResponseExpanded) GetAdditionalProperties ¶ added in v1.18.3 

func (o *TaskServiceCreateOffboardingResponseExpanded) GetAdditionalProperties() map[string]any

func (*TaskServiceCreateOffboardingResponseExpanded) GetAtType ¶ added in v1.18.3 

func (o *TaskServiceCreateOffboardingResponseExpanded) GetAtType() *string

func (TaskServiceCreateOffboardingResponseExpanded) MarshalJSON ¶ added in v1.18.3 

func (t TaskServiceCreateOffboardingResponseExpanded) MarshalJSON() ([]byte, error)

func (*TaskServiceCreateOffboardingResponseExpanded) UnmarshalJSON ¶ added in v1.18.3 

func (t *TaskServiceCreateOffboardingResponseExpanded) UnmarshalJSON(data []byte) error

type TaskServiceCreateRevokeRequest ¶ added in v1.0.3 

type TaskServiceCreateRevokeRequest struct {
	// The task expand mask is an array of strings that specifes the related objects the requester wishes to have returned when making a request where the expand mask is part of the input. Use '*' to view all possible responses.
	TaskExpandMask *TaskExpandMask `json:"expandMask,omitempty"`
	// The ID of the app entitlement to revoke access to.
	AppEntitlementID string `json:"appEntitlementId"`
	// The ID of the app associated with the entitlement.
	AppID string `json:"appId"`
	// The ID of the app user to revoke access from. This field and identityUserId cannot both be set for a given request.
	AppUserID *string `json:"appUserId,omitempty"`
	// The description of the request.
	Description *string `json:"description,omitempty"`
	// The ID of the user associated with the app user we are revoking access from. This field cannot be set if appUserID is also set.
	IdentityUserID *string `json:"identityUserId,omitempty"`
}

TaskServiceCreateRevokeRequest - Create a revoke task.

func (*TaskServiceCreateRevokeRequest) GetAppEntitlementID ¶ added in v1.6.1 

func (o *TaskServiceCreateRevokeRequest) GetAppEntitlementID() string

func (*TaskServiceCreateRevokeRequest) GetAppID ¶ added in v1.6.1 

func (o *TaskServiceCreateRevokeRequest) GetAppID() string

func (*TaskServiceCreateRevokeRequest) GetAppUserID ¶ added in v1.6.1 

func (o *TaskServiceCreateRevokeRequest) GetAppUserID() *string

func (*TaskServiceCreateRevokeRequest) GetDescription ¶ added in v1.6.1 

func (o *TaskServiceCreateRevokeRequest) GetDescription() *string

func (*TaskServiceCreateRevokeRequest) GetIdentityUserID ¶ added in v1.6.1 

func (o *TaskServiceCreateRevokeRequest) GetIdentityUserID() *string

func (*TaskServiceCreateRevokeRequest) GetTaskExpandMask ¶ added in v1.6.1 

func (o *TaskServiceCreateRevokeRequest) GetTaskExpandMask() *TaskExpandMask

type TaskServiceCreateRevokeResponse ¶ added in v1.0.3 

type TaskServiceCreateRevokeResponse struct {
	// Contains a task and JSONPATH expressions that describe where in the expanded array related objects are located. This view can be used to display a fully-detailed dashboard of task information.
	TaskView *TaskView `json:"taskView,omitempty"`
	// List of serialized related objects.
	Expanded []TaskServiceCreateRevokeResponseExpanded `json:"expanded,omitempty"`
}

The TaskServiceCreateRevokeResponse returns a task view which has a task including JSONPATHs to the expanded items in the expanded array.

func (*TaskServiceCreateRevokeResponse) GetExpanded ¶ added in v1.6.1 

func (o *TaskServiceCreateRevokeResponse) GetExpanded() []TaskServiceCreateRevokeResponseExpanded

func (*TaskServiceCreateRevokeResponse) GetTaskView ¶ added in v1.6.1 

func (o *TaskServiceCreateRevokeResponse) GetTaskView() *TaskView

type TaskServiceCreateRevokeResponseExpanded ¶ added in v1.10.1 

type TaskServiceCreateRevokeResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

TaskServiceCreateRevokeResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*TaskServiceCreateRevokeResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *TaskServiceCreateRevokeResponseExpanded) GetAdditionalProperties() map[string]any

func (*TaskServiceCreateRevokeResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *TaskServiceCreateRevokeResponseExpanded) GetAtType() *string

func (TaskServiceCreateRevokeResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (t TaskServiceCreateRevokeResponseExpanded) MarshalJSON() ([]byte, error)

func (*TaskServiceCreateRevokeResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (t *TaskServiceCreateRevokeResponseExpanded) UnmarshalJSON(data []byte) error

type TaskServiceGetResponse ¶ added in v1.0.3 

type TaskServiceGetResponse struct {
	// Contains a task and JSONPATH expressions that describe where in the expanded array related objects are located. This view can be used to display a fully-detailed dashboard of task information.
	TaskView *TaskView `json:"taskView,omitempty"`
	// List of serialized related objects.
	Expanded []TaskServiceGetResponseExpanded `json:"expanded,omitempty"`
}

The TaskServiceGetResponse returns a task view which has a task including JSONPATHs to the expanded items in the expanded array.

func (*TaskServiceGetResponse) GetExpanded ¶ added in v1.6.1 

func (o *TaskServiceGetResponse) GetExpanded() []TaskServiceGetResponseExpanded

func (*TaskServiceGetResponse) GetTaskView ¶ added in v1.6.1 

func (o *TaskServiceGetResponse) GetTaskView() *TaskView

type TaskServiceGetResponseExpanded ¶ added in v1.10.1 

type TaskServiceGetResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

TaskServiceGetResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*TaskServiceGetResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *TaskServiceGetResponseExpanded) GetAdditionalProperties() map[string]any

func (*TaskServiceGetResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *TaskServiceGetResponseExpanded) GetAtType() *string

func (TaskServiceGetResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (t TaskServiceGetResponseExpanded) MarshalJSON() ([]byte, error)

func (*TaskServiceGetResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (t *TaskServiceGetResponseExpanded) UnmarshalJSON(data []byte) error

type TaskState ¶ added in v1.0.3 

type TaskState string

TaskState - The current state of the task as defined by the `state_enum` 

const (
	TaskStateTaskStateUnspecified TaskState = "TASK_STATE_UNSPECIFIED"
	TaskStateTaskStateOpen        TaskState = "TASK_STATE_OPEN"
	TaskStateTaskStateClosed      TaskState = "TASK_STATE_CLOSED"
)

func (TaskState) ToPointer ¶ added in v1.0.3 

func (e TaskState) ToPointer() *TaskState

type TaskStates ¶ added in v1.15.0 

type TaskStates string
const (
	TaskStatesTaskStateUnspecified TaskStates = "TASK_STATE_UNSPECIFIED"
	TaskStatesTaskStateOpen        TaskStates = "TASK_STATE_OPEN"
	TaskStatesTaskStateClosed      TaskStates = "TASK_STATE_CLOSED"
)

func (TaskStates) ToPointer ¶ added in v1.15.0 

func (e TaskStates) ToPointer() *TaskStates

func (*TaskStates) UnmarshalJSON ¶ added in v1.15.0 

func (e *TaskStates) UnmarshalJSON(data []byte) error

type TaskType ¶ added in v1.0.3 

type TaskType struct {
	// The TaskTypeCertify message indicates that a task is a certify task and all related details.
	TaskTypeCertify *TaskTypeCertify `json:"certify,omitempty"`
	// The TaskTypeGrant message indicates that a task is a grant task and all related details.
	TaskTypeGrant *TaskTypeGrant `json:"grant,omitempty"`
	// The TaskTypeOffboarding message.
	TaskTypeOffboarding *TaskTypeOffboarding `json:"offboarding,omitempty"`
	// The TaskTypeRevoke message indicates that a task is a revoke task and all related details.
	TaskTypeRevoke *TaskTypeRevoke `json:"revoke,omitempty"`
}

TaskType - Task Type provides configuration for the type of task: certify, grant, or revoke

This message contains a oneof named task_type. Only a single field of the following list may be set at a time:

  • grant
  • revoke
  • certify
  • offboarding

func (*TaskType) GetTaskTypeCertify ¶ added in v1.6.1 

func (o *TaskType) GetTaskTypeCertify() *TaskTypeCertify

func (*TaskType) GetTaskTypeGrant ¶ added in v1.6.1 

func (o *TaskType) GetTaskTypeGrant() *TaskTypeGrant

func (*TaskType) GetTaskTypeOffboarding ¶ added in v1.18.3 

func (o *TaskType) GetTaskTypeOffboarding() *TaskTypeOffboarding

func (*TaskType) GetTaskTypeRevoke ¶ added in v1.6.1 

func (o *TaskType) GetTaskTypeRevoke() *TaskTypeRevoke

type TaskTypeCertify ¶ added in v1.0.3 

type TaskTypeCertify struct {
	// The ID of the access review.
	AccessReviewID *string `json:"accessReviewId,omitempty"`
	// The ID of the specific access review object that owns this certify task. This is also set on a revoke task if the revoke task is created from the denied outcome of a certify task.
	AccessReviewSelection *string `json:"accessReviewSelection,omitempty"`
	// The ID of the app entitlement.
	AppEntitlementID *string `json:"appEntitlementId,omitempty"`
	// The ID of the app.
	AppID *string `json:"appId,omitempty"`
	// The ID of the app user.
	AppUserID *string `json:"appUserId,omitempty"`
	// The ID of the user.
	IdentityUserID *string `json:"identityUserId,omitempty"`
	// The outcome of the certification.
	Outcome     *Outcome   `json:"outcome,omitempty"`
	OutcomeTime *time.Time `json:"outcomeTime,omitempty"`
}

The TaskTypeCertify message indicates that a task is a certify task and all related details.

func (*TaskTypeCertify) GetAccessReviewID ¶ added in v1.6.1 

func (o *TaskTypeCertify) GetAccessReviewID() *string

func (*TaskTypeCertify) GetAccessReviewSelection ¶ added in v1.6.1 

func (o *TaskTypeCertify) GetAccessReviewSelection() *string

func (*TaskTypeCertify) GetAppEntitlementID ¶ added in v1.6.1 

func (o *TaskTypeCertify) GetAppEntitlementID() *string

func (*TaskTypeCertify) GetAppID ¶ added in v1.6.1 

func (o *TaskTypeCertify) GetAppID() *string

func (*TaskTypeCertify) GetAppUserID ¶ added in v1.6.1 

func (o *TaskTypeCertify) GetAppUserID() *string

func (*TaskTypeCertify) GetIdentityUserID ¶ added in v1.6.1 

func (o *TaskTypeCertify) GetIdentityUserID() *string

func (*TaskTypeCertify) GetOutcome ¶ added in v1.6.1 

func (o *TaskTypeCertify) GetOutcome() *Outcome

func (*TaskTypeCertify) GetOutcomeTime ¶ added in v1.6.1 

func (o *TaskTypeCertify) GetOutcomeTime() *time.Time

func (TaskTypeCertify) MarshalJSON ¶ added in v1.10.1 

func (t TaskTypeCertify) MarshalJSON() ([]byte, error)

func (*TaskTypeCertify) UnmarshalJSON ¶ added in v1.10.1 

func (t *TaskTypeCertify) UnmarshalJSON(data []byte) error

type TaskTypeCertifyInput ¶ added in v1.8.0 

type TaskTypeCertifyInput struct {
}

TaskTypeCertifyInput - The TaskTypeCertify message indicates that a task is a certify task and all related details.

type TaskTypeGrant ¶ added in v1.0.3 

type TaskTypeGrant struct {
	// The TaskGrantSource message tracks which external URL was the source of the specificed grant ticket.
	TaskGrantSource *TaskGrantSource `json:"source,omitempty"`
	// The ID of the app entitlement.
	AppEntitlementID *string `json:"appEntitlementId,omitempty"`
	// The ID of the app.
	AppID *string `json:"appId,omitempty"`
	// The ID of the app user.
	AppUserID     *string `json:"appUserId,omitempty"`
	GrantDuration *string `json:"grantDuration,omitempty"`
	// The ID of the user.
	IdentityUserID *string `json:"identityUserId,omitempty"`
	// The outcome of the grant.
	Outcome     *TaskTypeGrantOutcome `json:"outcome,omitempty"`
	OutcomeTime *time.Time            `json:"outcomeTime,omitempty"`
}

The TaskTypeGrant message indicates that a task is a grant task and all related details.

func (*TaskTypeGrant) GetAppEntitlementID ¶ added in v1.6.1 

func (o *TaskTypeGrant) GetAppEntitlementID() *string

func (*TaskTypeGrant) GetAppID ¶ added in v1.6.1 

func (o *TaskTypeGrant) GetAppID() *string

func (*TaskTypeGrant) GetAppUserID ¶ added in v1.6.1 

func (o *TaskTypeGrant) GetAppUserID() *string

func (*TaskTypeGrant) GetGrantDuration ¶ added in v1.6.1 

func (o *TaskTypeGrant) GetGrantDuration() *string

func (*TaskTypeGrant) GetIdentityUserID ¶ added in v1.6.1 

func (o *TaskTypeGrant) GetIdentityUserID() *string

func (*TaskTypeGrant) GetOutcome ¶ added in v1.6.1 

func (o *TaskTypeGrant) GetOutcome() *TaskTypeGrantOutcome

func (*TaskTypeGrant) GetOutcomeTime ¶ added in v1.6.1 

func (o *TaskTypeGrant) GetOutcomeTime() *time.Time

func (*TaskTypeGrant) GetTaskGrantSource ¶ added in v1.8.0 

func (o *TaskTypeGrant) GetTaskGrantSource() *TaskGrantSource

func (TaskTypeGrant) MarshalJSON ¶ added in v1.10.1 

func (t TaskTypeGrant) MarshalJSON() ([]byte, error)

func (*TaskTypeGrant) UnmarshalJSON ¶ added in v1.10.1 

func (t *TaskTypeGrant) UnmarshalJSON(data []byte) error

type TaskTypeGrantInput ¶ added in v1.8.0 

type TaskTypeGrantInput struct {
	// The TaskGrantSource message tracks which external URL was the source of the specificed grant ticket.
	TaskGrantSource *TaskGrantSource `json:"source,omitempty"`
}

TaskTypeGrantInput - The TaskTypeGrant message indicates that a task is a grant task and all related details.

func (*TaskTypeGrantInput) GetTaskGrantSource ¶ added in v1.8.0 

func (o *TaskTypeGrantInput) GetTaskGrantSource() *TaskGrantSource

type TaskTypeGrantOutcome ¶ added in v1.0.3 

type TaskTypeGrantOutcome string

TaskTypeGrantOutcome - The outcome of the grant. 

const (
	TaskTypeGrantOutcomeGrantOutcomeUnspecified  TaskTypeGrantOutcome = "GRANT_OUTCOME_UNSPECIFIED"
	TaskTypeGrantOutcomeGrantOutcomeGranted      TaskTypeGrantOutcome = "GRANT_OUTCOME_GRANTED"
	TaskTypeGrantOutcomeGrantOutcomeDenied       TaskTypeGrantOutcome = "GRANT_OUTCOME_DENIED"
	TaskTypeGrantOutcomeGrantOutcomeError        TaskTypeGrantOutcome = "GRANT_OUTCOME_ERROR"
	TaskTypeGrantOutcomeGrantOutcomeCancelled    TaskTypeGrantOutcome = "GRANT_OUTCOME_CANCELLED"
	TaskTypeGrantOutcomeGrantOutcomeWaitTimedOut TaskTypeGrantOutcome = "GRANT_OUTCOME_WAIT_TIMED_OUT"
)

func (TaskTypeGrantOutcome) ToPointer ¶ added in v1.0.3 

func (e TaskTypeGrantOutcome) ToPointer() *TaskTypeGrantOutcome

type TaskTypeInput ¶ added in v1.7.1 

type TaskTypeInput struct {
	// The TaskTypeCertify message indicates that a task is a certify task and all related details.
	TaskTypeCertify *TaskTypeCertifyInput `json:"certify,omitempty"`
	// The TaskTypeGrant message indicates that a task is a grant task and all related details.
	TaskTypeGrant *TaskTypeGrantInput `json:"grant,omitempty"`
	// The TaskTypeOffboarding message.
	TaskTypeOffboarding *TaskTypeOffboardingInput `json:"offboarding,omitempty"`
	// The TaskTypeRevoke message indicates that a task is a revoke task and all related details.
	TaskTypeRevoke *TaskTypeRevokeInput `json:"revoke,omitempty"`
}

TaskTypeInput - Task Type provides configuration for the type of task: certify, grant, or revoke

This message contains a oneof named task_type. Only a single field of the following list may be set at a time:

  • grant
  • revoke
  • certify
  • offboarding

func (*TaskTypeInput) GetTaskTypeCertify ¶ added in v1.7.1 

func (o *TaskTypeInput) GetTaskTypeCertify() *TaskTypeCertifyInput

func (*TaskTypeInput) GetTaskTypeGrant ¶ added in v1.7.1 

func (o *TaskTypeInput) GetTaskTypeGrant() *TaskTypeGrantInput

func (*TaskTypeInput) GetTaskTypeOffboarding ¶ added in v1.18.3 

func (o *TaskTypeInput) GetTaskTypeOffboarding() *TaskTypeOffboardingInput

func (*TaskTypeInput) GetTaskTypeRevoke ¶ added in v1.7.1 

func (o *TaskTypeInput) GetTaskTypeRevoke() *TaskTypeRevokeInput

type TaskTypeOffboarding ¶ added in v1.18.3 

type TaskTypeOffboarding struct {
	// The outcome field.
	Outcome     *TaskTypeOffboardingOutcome `json:"outcome,omitempty"`
	OutcomeTime *time.Time                  `json:"outcomeTime,omitempty"`
	// The subjectUserId field.
	SubjectUserID *string `json:"subjectUserId,omitempty"`
}

The TaskTypeOffboarding message.

func (*TaskTypeOffboarding) GetOutcome ¶ added in v1.18.3 

func (o *TaskTypeOffboarding) GetOutcome() *TaskTypeOffboardingOutcome

func (*TaskTypeOffboarding) GetOutcomeTime ¶ added in v1.18.3 

func (o *TaskTypeOffboarding) GetOutcomeTime() *time.Time

func (*TaskTypeOffboarding) GetSubjectUserID ¶ added in v1.18.3 

func (o *TaskTypeOffboarding) GetSubjectUserID() *string

func (TaskTypeOffboarding) MarshalJSON ¶ added in v1.18.3 

func (t TaskTypeOffboarding) MarshalJSON() ([]byte, error)

func (*TaskTypeOffboarding) UnmarshalJSON ¶ added in v1.18.3 

func (t *TaskTypeOffboarding) UnmarshalJSON(data []byte) error

type TaskTypeOffboardingInput ¶ added in v1.18.3 

type TaskTypeOffboardingInput struct {
}

TaskTypeOffboardingInput - The TaskTypeOffboarding message.

type TaskTypeOffboardingOutcome ¶ added in v1.18.3 

type TaskTypeOffboardingOutcome string

TaskTypeOffboardingOutcome - The outcome field. 

const (
	TaskTypeOffboardingOutcomeOffboardingOutcomeUnspecified TaskTypeOffboardingOutcome = "OFFBOARDING_OUTCOME_UNSPECIFIED"
	TaskTypeOffboardingOutcomeOffboardingOutcomeInProgress  TaskTypeOffboardingOutcome = "OFFBOARDING_OUTCOME_IN_PROGRESS"
	TaskTypeOffboardingOutcomeOffboardingOutcomeDone        TaskTypeOffboardingOutcome = "OFFBOARDING_OUTCOME_DONE"
	TaskTypeOffboardingOutcomeOffboardingOutcomeError       TaskTypeOffboardingOutcome = "OFFBOARDING_OUTCOME_ERROR"
	TaskTypeOffboardingOutcomeOffboardingOutcomeCancelled   TaskTypeOffboardingOutcome = "OFFBOARDING_OUTCOME_CANCELLED"
)

func (TaskTypeOffboardingOutcome) ToPointer ¶ added in v1.18.3 

func (e TaskTypeOffboardingOutcome) ToPointer() *TaskTypeOffboardingOutcome

type TaskTypeRevoke ¶ added in v1.0.3 

type TaskTypeRevoke struct {
	// The TaskRevokeSource message indicates the source of the revoke task is one of expired, nonUsage, request, or review.
	//
	// This message contains a oneof named origin. Only a single field of the following list may be set at a time:
	//   - review
	//   - request
	//   - expired
	//   - nonUsage
	//
	TaskRevokeSource *TaskRevokeSource `json:"source,omitempty"`
	// The ID of the app entitlement.
	AppEntitlementID *string `json:"appEntitlementId,omitempty"`
	// The ID of the app.
	AppID *string `json:"appId,omitempty"`
	// The ID of the app user.
	AppUserID *string `json:"appUserId,omitempty"`
	// The ID of the user.
	IdentityUserID *string `json:"identityUserId,omitempty"`
	// The outcome of the revoke.
	Outcome     *TaskTypeRevokeOutcome `json:"outcome,omitempty"`
	OutcomeTime *time.Time             `json:"outcomeTime,omitempty"`
}

The TaskTypeRevoke message indicates that a task is a revoke task and all related details.

func (*TaskTypeRevoke) GetAppEntitlementID ¶ added in v1.6.1 

func (o *TaskTypeRevoke) GetAppEntitlementID() *string

func (*TaskTypeRevoke) GetAppID ¶ added in v1.6.1 

func (o *TaskTypeRevoke) GetAppID() *string

func (*TaskTypeRevoke) GetAppUserID ¶ added in v1.6.1 

func (o *TaskTypeRevoke) GetAppUserID() *string

func (*TaskTypeRevoke) GetIdentityUserID ¶ added in v1.6.1 

func (o *TaskTypeRevoke) GetIdentityUserID() *string

func (*TaskTypeRevoke) GetOutcome ¶ added in v1.6.1 

func (o *TaskTypeRevoke) GetOutcome() *TaskTypeRevokeOutcome

func (*TaskTypeRevoke) GetOutcomeTime ¶ added in v1.6.1 

func (o *TaskTypeRevoke) GetOutcomeTime() *time.Time

func (*TaskTypeRevoke) GetTaskRevokeSource ¶ added in v1.6.1 

func (o *TaskTypeRevoke) GetTaskRevokeSource() *TaskRevokeSource

func (TaskTypeRevoke) MarshalJSON ¶ added in v1.10.1 

func (t TaskTypeRevoke) MarshalJSON() ([]byte, error)

func (*TaskTypeRevoke) UnmarshalJSON ¶ added in v1.10.1 

func (t *TaskTypeRevoke) UnmarshalJSON(data []byte) error

type TaskTypeRevokeInput ¶ added in v1.7.1 

type TaskTypeRevokeInput struct {
	// The TaskRevokeSource message indicates the source of the revoke task is one of expired, nonUsage, request, or review.
	//
	// This message contains a oneof named origin. Only a single field of the following list may be set at a time:
	//   - review
	//   - request
	//   - expired
	//   - nonUsage
	//
	TaskRevokeSource *TaskRevokeSource `json:"source,omitempty"`
}

TaskTypeRevokeInput - The TaskTypeRevoke message indicates that a task is a revoke task and all related details.

func (*TaskTypeRevokeInput) GetTaskRevokeSource ¶ added in v1.7.1 

func (o *TaskTypeRevokeInput) GetTaskRevokeSource() *TaskRevokeSource

type TaskTypeRevokeOutcome ¶ added in v1.0.3 

type TaskTypeRevokeOutcome string

TaskTypeRevokeOutcome - The outcome of the revoke. 

const (
	TaskTypeRevokeOutcomeRevokeOutcomeUnspecified  TaskTypeRevokeOutcome = "REVOKE_OUTCOME_UNSPECIFIED"
	TaskTypeRevokeOutcomeRevokeOutcomeRevoked      TaskTypeRevokeOutcome = "REVOKE_OUTCOME_REVOKED"
	TaskTypeRevokeOutcomeRevokeOutcomeDenied       TaskTypeRevokeOutcome = "REVOKE_OUTCOME_DENIED"
	TaskTypeRevokeOutcomeRevokeOutcomeError        TaskTypeRevokeOutcome = "REVOKE_OUTCOME_ERROR"
	TaskTypeRevokeOutcomeRevokeOutcomeCancelled    TaskTypeRevokeOutcome = "REVOKE_OUTCOME_CANCELLED"
	TaskTypeRevokeOutcomeRevokeOutcomeWaitTimedOut TaskTypeRevokeOutcome = "REVOKE_OUTCOME_WAIT_TIMED_OUT"
)

func (TaskTypeRevokeOutcome) ToPointer ¶ added in v1.0.3 

func (e TaskTypeRevokeOutcome) ToPointer() *TaskTypeRevokeOutcome

type TaskView ¶ added in v1.0.3 

type TaskView struct {
	// A fully-fleged task object. Includes its policy, references to external apps, its type, its processing history, and more.
	Task *Task `json:"task,omitempty"`
	// JSONPATH expression indicating the location of the AccessReview object in the expanded array
	AccessReviewPath *string `json:"accessReviewPath,omitempty"`
	// JSONPATH expression indicating the location of the App object in the expanded array
	AppPath *string `json:"appPath,omitempty"`
	// JSONPATH expression indicating the location of the AppUser object in the expanded array
	AppUserPath *string `json:"appUserPath,omitempty"`
	// JSONPATH expression indicating the location of the object of the User that created the ticket in the expanded array
	CreatedByUserPath *string `json:"createdByUserPath,omitempty"`
	// JSONPATH expression indicating the location of the Entitlements objects in the expanded array
	EntitlementsPath *string `json:"entitlementsPath,omitempty"`
	// JSONPATH expression indicating the location of the User object of the User that this task is targeting in the expanded array. This is the user that is the identity when the target of a task is an app user.
	IdentityUserPath *string `json:"identityUserPath,omitempty"`
	// JSONPATH expression indicating the location of the Insights objects in the expanded array
	InsightsPath *string `json:"insightsPath,omitempty"`
	// JSONPATH expression indicating the location of the StepApproverUsers objects in the expanded array
	StepApproversPath *string `json:"stepApproversPath,omitempty"`
	// JSONPATH expression indicating the location of the User object in the expanded array. This is the user that is a direct target of the ticket without a specific relationship to a potentially non-existent app user.
	UserPath *string `json:"userPath,omitempty"`
}

TaskView - Contains a task and JSONPATH expressions that describe where in the expanded array related objects are located. This view can be used to display a fully-detailed dashboard of task information.

func (*TaskView) GetAccessReviewPath ¶ added in v1.6.1 

func (o *TaskView) GetAccessReviewPath() *string

func (*TaskView) GetAppPath ¶ added in v1.6.1 

func (o *TaskView) GetAppPath() *string

func (*TaskView) GetAppUserPath ¶ added in v1.6.1 

func (o *TaskView) GetAppUserPath() *string

func (*TaskView) GetCreatedByUserPath ¶ added in v1.6.1 

func (o *TaskView) GetCreatedByUserPath() *string

func (*TaskView) GetEntitlementsPath ¶ added in v1.6.1 

func (o *TaskView) GetEntitlementsPath() *string

func (*TaskView) GetIdentityUserPath ¶ added in v1.6.1 

func (o *TaskView) GetIdentityUserPath() *string

func (*TaskView) GetInsightsPath ¶ added in v1.15.0 

func (o *TaskView) GetInsightsPath() *string

func (*TaskView) GetStepApproversPath ¶ added in v1.6.1 

func (o *TaskView) GetStepApproversPath() *string

func (*TaskView) GetTask ¶ added in v1.6.1 

func (o *TaskView) GetTask() *Task

func (*TaskView) GetUserPath ¶ added in v1.6.1 

func (o *TaskView) GetUserPath() *string

type TestSourceIPRequest ¶ added in v1.21.4 

type TestSourceIPRequest struct {
	// The allowCidr field.
	AllowCidr []string `json:"allowCidr,omitempty"`
	// if unset, uses the source IP of the request
	SourceIP *string `json:"sourceIp,omitempty"`
}

The TestSourceIPRequest message.

func (*TestSourceIPRequest) GetAllowCidr ¶ added in v1.21.4 

func (o *TestSourceIPRequest) GetAllowCidr() []string

func (*TestSourceIPRequest) GetSourceIP ¶ added in v1.21.4 

func (o *TestSourceIPRequest) GetSourceIP() *string

type TestSourceIPResponse ¶ added in v1.21.4 

type TestSourceIPResponse struct {
	// The `Status` type defines a logical error model that is suitable for
	//  different programming environments, including REST APIs and RPC APIs. It is
	//  used by [gRPC](https://github.com/grpc). Each `Status` message contains
	//  three pieces of data: error code, error message, and error details.
	//
	//  You can find out more about this error model and how to work with it in the
	//  [API Design Guide](https://cloud.google.com/apis/design/errors).
	Status *Status `json:"details,omitempty"`
	// The allowed field.
	Allowed *bool `json:"allowed,omitempty"`
	// The checkedIp field.
	CheckedIP *string `json:"checkedIp,omitempty"`
}

The TestSourceIPResponse message.

func (*TestSourceIPResponse) GetAllowed ¶ added in v1.21.4 

func (o *TestSourceIPResponse) GetAllowed() *bool

func (*TestSourceIPResponse) GetCheckedIP ¶ added in v1.21.4 

func (o *TestSourceIPResponse) GetCheckedIP() *string

func (*TestSourceIPResponse) GetStatus ¶ added in v1.21.4 

func (o *TestSourceIPResponse) GetStatus() *Status

type UnenrollmentBehavior ¶ added in v1.21.3 

type UnenrollmentBehavior string

UnenrollmentBehavior - Defines how to handle the revocation of the entitlements in the catalog during unenrollment. 

const (
	UnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorUnspecified       UnenrollmentBehavior = "REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_UNSPECIFIED"
	UnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorLeaveAccessAsIs   UnenrollmentBehavior = "REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_LEAVE_ACCESS_AS_IS"
	UnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRevokeAll         UnenrollmentBehavior = "REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_REVOKE_ALL"
	UnenrollmentBehaviorRequestCatalogUnenrollmentBehaviorRevokeUnjustified UnenrollmentBehavior = "REQUEST_CATALOG_UNENROLLMENT_BEHAVIOR_REVOKE_UNJUSTIFIED"
)

func (UnenrollmentBehavior) ToPointer ¶ added in v1.21.3 

func (e UnenrollmentBehavior) ToPointer() *UnenrollmentBehavior

type UnenrollmentEntitlementBehavior ¶ added in v1.21.4 

type UnenrollmentEntitlementBehavior string

UnenrollmentEntitlementBehavior - Defines how to handle the revoke policies of the entitlements in the catalog during unenrollment. 

const (
	UnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorUnspecified UnenrollmentEntitlementBehavior = "REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_UNSPECIFIED"
	UnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorBypass      UnenrollmentEntitlementBehavior = "REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_BYPASS"
	UnenrollmentEntitlementBehaviorRequestCatalogUnenrollmentEntitlementBehaviorEnforce     UnenrollmentEntitlementBehavior = "REQUEST_CATALOG_UNENROLLMENT_ENTITLEMENT_BEHAVIOR_ENFORCE"
)

func (UnenrollmentEntitlementBehavior) ToPointer ¶ added in v1.21.4 

func (e UnenrollmentEntitlementBehavior) ToPointer() *UnenrollmentEntitlementBehavior

type UpdateAppEntitlementRequest ¶ added in v1.15.0 

type UpdateAppEntitlementRequest struct {
	// The app entitlement represents one permission in a downstream App (SAAS) that can be granted. For example, GitHub Read vs GitHub Write.
	//
	// This message contains a oneof named max_grant_duration. Only a single field of the following list may be set at a time:
	//   - durationUnset
	//   - durationGrant
	//
	AppEntitlement *AppEntitlementInput `json:"entitlement,omitempty"`
	// The app entitlement expand mask allows the user to get additional information when getting responses containing app entitlement views.
	AppEntitlementExpandMask *AppEntitlementExpandMask `json:"expandMask,omitempty"`
	// Flag to indicate that access request defaults, if any are applied to these entitlements, should be overridden.
	OverrideAccessRequestsDefaults *bool   `json:"overrideAccessRequestsDefaults,omitempty"`
	UpdateMask                     *string `json:"updateMask,omitempty"`
}

The UpdateAppEntitlementRequest message contains the app entitlement and the fields to be updated.

func (*UpdateAppEntitlementRequest) GetAppEntitlement ¶ added in v1.15.0 

func (o *UpdateAppEntitlementRequest) GetAppEntitlement() *AppEntitlementInput

func (*UpdateAppEntitlementRequest) GetAppEntitlementExpandMask ¶ added in v1.15.0 

func (o *UpdateAppEntitlementRequest) GetAppEntitlementExpandMask() *AppEntitlementExpandMask

func (*UpdateAppEntitlementRequest) GetOverrideAccessRequestsDefaults ¶ added in v1.18.3 

func (o *UpdateAppEntitlementRequest) GetOverrideAccessRequestsDefaults() *bool

func (*UpdateAppEntitlementRequest) GetUpdateMask ¶ added in v1.15.0 

func (o *UpdateAppEntitlementRequest) GetUpdateMask() *string

type UpdateAppEntitlementResponse ¶ added in v1.7.0 

type UpdateAppEntitlementResponse struct {
	// The app entitlement view contains the serialized app entitlement and paths to objects referenced by the app entitlement.
	AppEntitlementView *AppEntitlementView `json:"appEntitlementView,omitempty"`
	// List of related objects
	Expanded []UpdateAppEntitlementResponseExpanded `json:"expanded,omitempty"`
}

The UpdateAppEntitlementResponse message.

func (*UpdateAppEntitlementResponse) GetAppEntitlementView ¶ added in v1.7.0 

func (o *UpdateAppEntitlementResponse) GetAppEntitlementView() *AppEntitlementView

func (*UpdateAppEntitlementResponse) GetExpanded ¶ added in v1.7.0 

func (o *UpdateAppEntitlementResponse) GetExpanded() []UpdateAppEntitlementResponseExpanded

type UpdateAppEntitlementResponseExpanded ¶ added in v1.10.1 

type UpdateAppEntitlementResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

UpdateAppEntitlementResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*UpdateAppEntitlementResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *UpdateAppEntitlementResponseExpanded) GetAdditionalProperties() map[string]any

func (*UpdateAppEntitlementResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *UpdateAppEntitlementResponseExpanded) GetAtType() *string

func (UpdateAppEntitlementResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (u UpdateAppEntitlementResponseExpanded) MarshalJSON() ([]byte, error)

func (*UpdateAppEntitlementResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (u *UpdateAppEntitlementResponseExpanded) UnmarshalJSON(data []byte) error

type UpdateAppRequest ¶ added in v1.15.0 

type UpdateAppRequest struct {
	// The App object provides all of the details for an app, as well as some configuration.
	App        *AppInput `json:"app,omitempty"`
	UpdateMask *string   `json:"updateMask,omitempty"`
}

The UpdateAppRequest message contains the app to update and the fields to update.

func (*UpdateAppRequest) GetApp ¶ added in v1.15.0 

func (o *UpdateAppRequest) GetApp() *AppInput

func (*UpdateAppRequest) GetUpdateMask ¶ added in v1.15.0 

func (o *UpdateAppRequest) GetUpdateMask() *string

type UpdateAppResponse ¶ added in v1.7.0 

type UpdateAppResponse struct {
	// The App object provides all of the details for an app, as well as some configuration.
	App *App `json:"app,omitempty"`
}

UpdateAppResponse - Returns the updated app's new values.

func (*UpdateAppResponse) GetApp ¶ added in v1.7.0 

func (o *UpdateAppResponse) GetApp() *App

type UpdateAppUsageControlsRequest ¶ added in v1.5.0 

type UpdateAppUsageControlsRequest struct {
	// The AppUsageControls object describes some peripheral configuration for an app.
	AppUsageControls *AppUsageControls `json:"appUsageControls,omitempty"`
	UpdateMask       *string           `json:"updateMask,omitempty"`
}

The UpdateAppUsageControlsRequest message contains the AppUsageControls object to update and the update mask.

func (*UpdateAppUsageControlsRequest) GetAppUsageControls ¶ added in v1.6.1 

func (o *UpdateAppUsageControlsRequest) GetAppUsageControls() *AppUsageControls

func (*UpdateAppUsageControlsRequest) GetUpdateMask ¶ added in v1.6.1 

func (o *UpdateAppUsageControlsRequest) GetUpdateMask() *string

type UpdateAppUsageControlsResponse ¶ added in v1.5.0 

type UpdateAppUsageControlsResponse struct {
	// The AppUsageControls object describes some peripheral configuration for an app.
	AppUsageControls *AppUsageControls `json:"appUsageControls,omitempty"`
}

The UpdateAppUsageControlsResponse message contains the updated AppUsageControls object.

func (*UpdateAppUsageControlsResponse) GetAppUsageControls ¶ added in v1.6.1 

func (o *UpdateAppUsageControlsResponse) GetAppUsageControls() *AppUsageControls

type UpdateManuallyManagedResourceTypeRequest ¶ added in v1.20.0 

type UpdateManuallyManagedResourceTypeRequest struct {
	// The AppResourceType is referenced by an app entitlement defining its resource types. Commonly things like Group or Role.
	AppResourceType *AppResourceTypeInput `json:"appResourceType,omitempty"`
	UpdateMask      *string               `json:"updateMask,omitempty"`
}

The UpdateManuallyManagedResourceTypeRequest message.

func (*UpdateManuallyManagedResourceTypeRequest) GetAppResourceType ¶ added in v1.20.0 

func (o *UpdateManuallyManagedResourceTypeRequest) GetAppResourceType() *AppResourceTypeInput

func (*UpdateManuallyManagedResourceTypeRequest) GetUpdateMask ¶ added in v1.20.0 

func (o *UpdateManuallyManagedResourceTypeRequest) GetUpdateMask() *string

type UpdateManuallyManagedResourceTypeResponse ¶ added in v1.20.0 

type UpdateManuallyManagedResourceTypeResponse struct {
	// The AppResourceType is referenced by an app entitlement defining its resource types. Commonly things like Group or Role.
	AppResourceType *AppResourceType `json:"appResourceType,omitempty"`
	// The expanded field.
	Expanded []UpdateManuallyManagedResourceTypeResponseExpanded `json:"expanded,omitempty"`
}

The UpdateManuallyManagedResourceTypeResponse message.

func (*UpdateManuallyManagedResourceTypeResponse) GetAppResourceType ¶ added in v1.20.0 

func (o *UpdateManuallyManagedResourceTypeResponse) GetAppResourceType() *AppResourceType

func (*UpdateManuallyManagedResourceTypeResponse) GetExpanded ¶ added in v1.20.0 

func (o *UpdateManuallyManagedResourceTypeResponse) GetExpanded() []UpdateManuallyManagedResourceTypeResponseExpanded

type UpdateManuallyManagedResourceTypeResponseExpanded ¶ added in v1.20.0 

type UpdateManuallyManagedResourceTypeResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

UpdateManuallyManagedResourceTypeResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*UpdateManuallyManagedResourceTypeResponseExpanded) GetAdditionalProperties ¶ added in v1.20.0 

func (o *UpdateManuallyManagedResourceTypeResponseExpanded) GetAdditionalProperties() map[string]any

func (*UpdateManuallyManagedResourceTypeResponseExpanded) GetAtType ¶ added in v1.20.0 

func (o *UpdateManuallyManagedResourceTypeResponseExpanded) GetAtType() *string

func (UpdateManuallyManagedResourceTypeResponseExpanded) MarshalJSON ¶ added in v1.20.0 

func (u UpdateManuallyManagedResourceTypeResponseExpanded) MarshalJSON() ([]byte, error)

func (*UpdateManuallyManagedResourceTypeResponseExpanded) UnmarshalJSON ¶ added in v1.20.0 

func (u *UpdateManuallyManagedResourceTypeResponseExpanded) UnmarshalJSON(data []byte) error

type UpdatePolicyRequest ¶ added in v1.3.0 

type UpdatePolicyRequest struct {
	// A policy describes the behavior of the ConductorOne system when processing a task. You can describe the type, approvers, fallback behavior, and escalation processes.
	Policy     *PolicyInput `json:"policy,omitempty"`
	UpdateMask *string      `json:"updateMask,omitempty"`
}

The UpdatePolicyRequest message contains the policy object to update and a field mask to indicate which fields to update. It uses URL value for input.

func (*UpdatePolicyRequest) GetPolicy ¶ added in v1.6.1 

func (o *UpdatePolicyRequest) GetPolicy() *PolicyInput

func (*UpdatePolicyRequest) GetUpdateMask ¶ added in v1.6.1 

func (o *UpdatePolicyRequest) GetUpdateMask() *string

type UpdatePolicyResponse ¶ added in v1.3.0 

type UpdatePolicyResponse struct {
	// A policy describes the behavior of the ConductorOne system when processing a task. You can describe the type, approvers, fallback behavior, and escalation processes.
	Policy *Policy `json:"policy,omitempty"`
}

The UpdatePolicyResponse message contains the updated policy object.

func (*UpdatePolicyResponse) GetPolicy ¶ added in v1.6.1 

func (o *UpdatePolicyResponse) GetPolicy() *Policy

type UpdateRoleRequest ¶ added in v1.5.0 

type UpdateRoleRequest struct {
	// Role is a role that can be assigned to a user in ConductorOne.
	Role       *RoleInput `json:"role,omitempty"`
	UpdateMask *string    `json:"updateMask,omitempty"`
}

The UpdateRoleRequest message contains the role to update and the update mask.

func (*UpdateRoleRequest) GetRole ¶ added in v1.6.1 

func (o *UpdateRoleRequest) GetRole() *RoleInput

func (*UpdateRoleRequest) GetUpdateMask ¶ added in v1.6.1 

func (o *UpdateRoleRequest) GetUpdateMask() *string

type UpdateRolesResponse ¶ added in v1.5.0 

type UpdateRolesResponse struct {
	// Role is a role that can be assigned to a user in ConductorOne.
	Role *Role `json:"role,omitempty"`
}

UpdateRolesResponse is the response message containing the updated role.

func (*UpdateRolesResponse) GetRole ¶ added in v1.6.1 

func (o *UpdateRolesResponse) GetRole() *Role

type UpdateSessionSettingsRequest ¶ added in v1.16.0 

type UpdateSessionSettingsRequest struct {
	// The SessionSettings message.
	SessionSettings *SessionSettings `json:"sessionSettings,omitempty"`
	UpdateMask      *string          `json:"updateMask,omitempty"`
}

The UpdateSessionSettingsRequest message.

func (*UpdateSessionSettingsRequest) GetSessionSettings ¶ added in v1.16.0 

func (o *UpdateSessionSettingsRequest) GetSessionSettings() *SessionSettings

func (*UpdateSessionSettingsRequest) GetUpdateMask ¶ added in v1.16.0 

func (o *UpdateSessionSettingsRequest) GetUpdateMask() *string

type UpdateSessionSettingsResponse ¶ added in v1.16.0 

type UpdateSessionSettingsResponse struct {
	// The SessionSettings message.
	SessionSettings *SessionSettings `json:"sessionSettings,omitempty"`
}

The UpdateSessionSettingsResponse message.

func (*UpdateSessionSettingsResponse) GetSessionSettings ¶ added in v1.16.0 

func (o *UpdateSessionSettingsResponse) GetSessionSettings() *SessionSettings

type User ¶ added in v1.0.3 

type User struct {
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	// The id of the user to whom tasks will be automatically reassigned to.
	DelegatedUserID *string    `json:"delegatedUserId,omitempty"`
	DeletedAt       *time.Time `json:"deletedAt,omitempty"`
	// The department which the user belongs to in the organization.
	Department *string `json:"department,omitempty"`
	// A list of objects mapped based on department attribute mappings configured in the system.
	DepartmentSources []UserAttributeMappingSource `json:"departmentSources,omitempty"`
	// A list of unique ids that represent different directories.
	DirectoryIds []string `json:"directoryIds,omitempty"`
	// The status of the user in the directory.
	DirectoryStatus *DirectoryStatus `json:"directoryStatus,omitempty"`
	// A list of objects mapped based on directoryStatus attribute mappings configured in the system.
	DirectoryStatusSources []UserAttributeMappingSource `json:"directoryStatusSources,omitempty"`
	// The display name of the user.
	DisplayName *string `json:"displayName,omitempty"`
	// This is the user's email.
	Email *string `json:"email,omitempty"`
	// This is a list of all of the user's emails from app users.
	Emails []string `json:"emails,omitempty"`
	// The users employment status.
	EmploymentStatus *string `json:"employmentStatus,omitempty"`
	// A list of objects mapped based on employmentStatus attribute mappings configured in the system.
	EmploymentStatusSources []UserAttributeMappingSource `json:"employmentStatusSources,omitempty"`
	// The employment type of the user.
	EmploymentType *string `json:"employmentType,omitempty"`
	// A list of objects mapped based on employmentType attribute mappings configured in the system.
	EmploymentTypeSources []UserAttributeMappingSource `json:"employmentTypeSources,omitempty"`
	// A unique identifier of the user.
	ID *string `json:"id,omitempty"`
	// The job title of the user.
	JobTitle *string `json:"jobTitle,omitempty"`
	// A list of objects mapped based on jobTitle attribute mappings configured in the system.
	JobTitleSources []UserAttributeMappingSource `json:"jobTitleSources,omitempty"`
	// A list of ids of the user's managers.
	ManagerIds []string `json:"managerIds,omitempty"`
	// A list of objects mapped based on managerId attribute mappings configured in the system.
	ManagerSources []UserAttributeMappingSource `json:"managerSources,omitempty"`
	Profile        map[string]any               `json:"profile,omitempty"`
	// A list of unique identifiers that maps to ConductorOne’s user roles let you assign users permissions tailored to the work they do in the software.
	RoleIds []string `json:"roleIds,omitempty"`
	// The status of the user in the system.
	Status    *UserStatus `json:"status,omitempty"`
	UpdatedAt *time.Time  `json:"updatedAt,omitempty"`
	// This is the user's primary username. Typically sourced from the primary directory.
	Username *string `json:"username,omitempty"`
	// A list of source data for the usernames attribute.
	UsernameSources []UserAttributeMappingSource `json:"usernameSources,omitempty"`
	// This is a list of all of the user's usernames from app users.
	Usernames []string `json:"usernames,omitempty"`
}

The User object provides all of the details for an user, as well as some configuration.

func (*User) GetCreatedAt ¶ added in v1.6.1 

func (o *User) GetCreatedAt() *time.Time

func (*User) GetDelegatedUserID ¶ added in v1.6.1 

func (o *User) GetDelegatedUserID() *string

func (*User) GetDeletedAt ¶ added in v1.6.1 

func (o *User) GetDeletedAt() *time.Time

func (*User) GetDepartment ¶ added in v1.6.1 

func (o *User) GetDepartment() *string

func (*User) GetDepartmentSources ¶ added in v1.6.1 

func (o *User) GetDepartmentSources() []UserAttributeMappingSource

func (*User) GetDirectoryIds ¶ added in v1.6.1 

func (o *User) GetDirectoryIds() []string

func (*User) GetDirectoryStatus ¶ added in v1.6.1 

func (o *User) GetDirectoryStatus() *DirectoryStatus

func (*User) GetDirectoryStatusSources ¶ added in v1.6.1 

func (o *User) GetDirectoryStatusSources() []UserAttributeMappingSource

func (*User) GetDisplayName ¶ added in v1.6.1 

func (o *User) GetDisplayName() *string

func (*User) GetEmail ¶ added in v1.6.1 

func (o *User) GetEmail() *string

func (*User) GetEmails ¶ added in v1.14.0 

func (o *User) GetEmails() []string

func (*User) GetEmploymentStatus ¶ added in v1.6.1 

func (o *User) GetEmploymentStatus() *string

func (*User) GetEmploymentStatusSources ¶ added in v1.6.1 

func (o *User) GetEmploymentStatusSources() []UserAttributeMappingSource

func (*User) GetEmploymentType ¶ added in v1.6.1 

func (o *User) GetEmploymentType() *string

func (*User) GetEmploymentTypeSources ¶ added in v1.6.1 

func (o *User) GetEmploymentTypeSources() []UserAttributeMappingSource

func (*User) GetID ¶ added in v1.6.1 

func (o *User) GetID() *string

func (*User) GetJobTitle ¶ added in v1.6.1 

func (o *User) GetJobTitle() *string

func (*User) GetJobTitleSources ¶ added in v1.6.1 

func (o *User) GetJobTitleSources() []UserAttributeMappingSource

func (*User) GetManagerIds ¶ added in v1.6.1 

func (o *User) GetManagerIds() []string

func (*User) GetManagerSources ¶ added in v1.6.1 

func (o *User) GetManagerSources() []UserAttributeMappingSource

func (*User) GetProfile ¶ added in v1.11.2 

func (o *User) GetProfile() map[string]any

func (*User) GetRoleIds ¶ added in v1.6.1 

func (o *User) GetRoleIds() []string

func (*User) GetStatus ¶ added in v1.6.1 

func (o *User) GetStatus() *UserStatus

func (*User) GetUpdatedAt ¶ added in v1.6.1 

func (o *User) GetUpdatedAt() *time.Time

func (*User) GetUsername ¶ added in v1.14.0 

func (o *User) GetUsername() *string

func (*User) GetUsernameSources ¶ added in v1.18.3 

func (o *User) GetUsernameSources() []UserAttributeMappingSource

func (*User) GetUsernames ¶ added in v1.14.0 

func (o *User) GetUsernames() []string

func (User) MarshalJSON ¶ added in v1.10.1 

func (u User) MarshalJSON() ([]byte, error)

func (*User) UnmarshalJSON ¶ added in v1.10.1 

func (u *User) UnmarshalJSON(data []byte) error

type UserApproval ¶ added in v1.0.3 

type UserApproval struct {
	// Configuration to allow self approval of if the user is specified and also the target of the ticket.
	AllowSelfApproval *bool `json:"allowSelfApproval,omitempty"`
	// Array of users configured for approval.
	UserIds []string `json:"userIds,omitempty"`
}

UserApproval - The user approval object describes the approval configuration of a policy step that needs to be approved by a specific list of users.

func (*UserApproval) GetAllowSelfApproval ¶ added in v1.6.1 

func (o *UserApproval) GetAllowSelfApproval() *bool

func (*UserApproval) GetUserIds ¶ added in v1.6.1 

func (o *UserApproval) GetUserIds() []string

type UserAttributeMappingSource ¶ added in v1.0.3 

type UserAttributeMappingSource struct {
	// The appId field.
	AppID *string `json:"appId,omitempty"`
	// The appUserId field.
	AppUserID *string `json:"appUserId,omitempty"`
	// The appUserProfileAttributeKey field.
	AppUserProfileAttributeKey *string `json:"appUserProfileAttributeKey,omitempty"`
	// The userAttributeMappingId field.
	UserAttributeMappingID *string `json:"userAttributeMappingId,omitempty"`
	// The value field.
	Value *string `json:"value,omitempty"`
}

The UserAttributeMappingSource message.

func (*UserAttributeMappingSource) GetAppID ¶ added in v1.6.1 

func (o *UserAttributeMappingSource) GetAppID() *string

func (*UserAttributeMappingSource) GetAppUserID ¶ added in v1.6.1 

func (o *UserAttributeMappingSource) GetAppUserID() *string

func (*UserAttributeMappingSource) GetAppUserProfileAttributeKey ¶ added in v1.6.1 

func (o *UserAttributeMappingSource) GetAppUserProfileAttributeKey() *string

func (*UserAttributeMappingSource) GetUserAttributeMappingID ¶ added in v1.6.1 

func (o *UserAttributeMappingSource) GetUserAttributeMappingID() *string

func (*UserAttributeMappingSource) GetValue ¶ added in v1.6.1 

func (o *UserAttributeMappingSource) GetValue() *string

type UserExpandMask ¶ added in v1.0.3 

type UserExpandMask struct {
	// An array of paths to be expanded in the response.
	Paths []string `json:"paths,omitempty"`
}

UserExpandMask - The user expand mask is used to indicate which related objects should be expanded in the response. 

The supported paths are 'role_ids', 'manager_ids', 'delegated_user_id', 'directory_ids', and '*'.

func (*UserExpandMask) GetPaths ¶ added in v1.6.1 

func (o *UserExpandMask) GetPaths() []string

type UserRef ¶ added in v1.0.3 

type UserRef struct {
	// The id of the user.
	ID *string `json:"id,omitempty"`
}

UserRef - A reference to a user.

func (*UserRef) GetID ¶ added in v1.6.1 

func (o *UserRef) GetID() *string

type UserServiceGetResponse ¶ added in v1.0.3 

type UserServiceGetResponse struct {
	// The UserView object provides a user response object, as well as JSONPATHs to related objects provided by expanders.
	UserView *UserView `json:"userView,omitempty"`
	// List of serialized related objects.
	Expanded []UserServiceGetResponseExpanded `json:"expanded,omitempty"`
}

The UserServiceGetResponse returns a user view which has a user including JSONPATHs to the expanded items in the expanded array.

func (*UserServiceGetResponse) GetExpanded ¶ added in v1.6.1 

func (o *UserServiceGetResponse) GetExpanded() []UserServiceGetResponseExpanded

func (*UserServiceGetResponse) GetUserView ¶ added in v1.6.1 

func (o *UserServiceGetResponse) GetUserView() *UserView

type UserServiceGetResponseExpanded ¶ added in v1.10.1 

type UserServiceGetResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

UserServiceGetResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*UserServiceGetResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *UserServiceGetResponseExpanded) GetAdditionalProperties() map[string]any

func (*UserServiceGetResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *UserServiceGetResponseExpanded) GetAtType() *string

func (UserServiceGetResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (u UserServiceGetResponseExpanded) MarshalJSON() ([]byte, error)

func (*UserServiceGetResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (u *UserServiceGetResponseExpanded) UnmarshalJSON(data []byte) error

type UserServiceListResponse ¶ added in v1.0.3 

type UserServiceListResponse struct {
	// List of serialized related objects.
	Expanded []UserServiceListResponseExpanded `json:"expanded,omitempty"`
	// The list of results containing up to X results, where X is the page size defined in the request
	List []UserView `json:"list,omitempty"`
	// The nextPageToken is shown for the next page if the number of results is larger than the max page size.
	//  The server returns one page of results and the nextPageToken until all results are retreived.
	//  To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The UserServiceListResponse message contains a list of results and a nextPageToken if applicable.

func (*UserServiceListResponse) GetExpanded ¶ added in v1.6.1 

func (o *UserServiceListResponse) GetExpanded() []UserServiceListResponseExpanded

func (*UserServiceListResponse) GetList ¶ added in v1.6.1 

func (o *UserServiceListResponse) GetList() []UserView

func (*UserServiceListResponse) GetNextPageToken ¶ added in v1.6.1 

func (o *UserServiceListResponse) GetNextPageToken() *string

type UserServiceListResponseExpanded ¶ added in v1.10.1 

type UserServiceListResponseExpanded struct {
	// The type of the serialized message.
	AtType               *string        `json:"@type,omitempty"`
	AdditionalProperties map[string]any `additionalProperties:"true" json:"-"`
}

UserServiceListResponseExpanded - Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func (*UserServiceListResponseExpanded) GetAdditionalProperties ¶ added in v1.10.1 

func (o *UserServiceListResponseExpanded) GetAdditionalProperties() map[string]any

func (*UserServiceListResponseExpanded) GetAtType ¶ added in v1.10.1 

func (o *UserServiceListResponseExpanded) GetAtType() *string

func (UserServiceListResponseExpanded) MarshalJSON ¶ added in v1.10.1 

func (u UserServiceListResponseExpanded) MarshalJSON() ([]byte, error)

func (*UserServiceListResponseExpanded) UnmarshalJSON ¶ added in v1.10.1 

func (u *UserServiceListResponseExpanded) UnmarshalJSON(data []byte) error

type UserStatus ¶ added in v1.0.3 

type UserStatus string

UserStatus - The status of the user in the system. 

const (
	UserStatusUnknown  UserStatus = "UNKNOWN"
	UserStatusEnabled  UserStatus = "ENABLED"
	UserStatusDisabled UserStatus = "DISABLED"
	UserStatusDeleted  UserStatus = "DELETED"
)

func (UserStatus) ToPointer ¶ added in v1.0.3 

func (e UserStatus) ToPointer() *UserStatus

type UserStatuses ¶ added in v1.15.0 

type UserStatuses string
const (
	UserStatusesUnknown  UserStatuses = "UNKNOWN"
	UserStatusesEnabled  UserStatuses = "ENABLED"
	UserStatusesDisabled UserStatuses = "DISABLED"
	UserStatusesDeleted  UserStatuses = "DELETED"
)

func (UserStatuses) ToPointer ¶ added in v1.15.0 

func (e UserStatuses) ToPointer() *UserStatuses

func (*UserStatuses) UnmarshalJSON ¶ added in v1.15.0 

func (e *UserStatuses) UnmarshalJSON(data []byte) error

type UserView ¶ added in v1.0.3 

type UserView struct {
	// The User object provides all of the details for an user, as well as some configuration.
	User *User `json:"user,omitempty"`
	// JSONPATH expression indicating the location of the user objects of delegates of the current user in the expanded array.
	DelegatedUserPath *string `json:"delegatedUserPath,omitempty"`
	// JSONPATH expression indicating the location of directory objects in the expanded array.
	DirectoriesPath *string `json:"directoriesPath,omitempty"`
	// JSONPATH expression indicating the location of the user objects that managed the current user in the expanded array.
	ManagersPath *string `json:"managersPath,omitempty"`
	// JSONPATH expression indicating the location of the roles of the current user in the expanded array.
	RolesPath *string `json:"rolesPath,omitempty"`
}

The UserView object provides a user response object, as well as JSONPATHs to related objects provided by expanders.

func (*UserView) GetDelegatedUserPath ¶ added in v1.6.1 

func (o *UserView) GetDelegatedUserPath() *string

func (*UserView) GetDirectoriesPath ¶ added in v1.6.1 

func (o *UserView) GetDirectoriesPath() *string

func (*UserView) GetManagersPath ¶ added in v1.6.1 

func (o *UserView) GetManagersPath() *string

func (*UserView) GetRolesPath ¶ added in v1.6.1 

func (o *UserView) GetRolesPath() *string

func (*UserView) GetUser ¶ added in v1.6.1 

func (o *UserView) GetUser() *User

type ValidatePolicyCELRequest ¶ added in v1.15.0 

type ValidatePolicyCELRequest struct {
	// The cel field.
	Cel *string `json:"cel,omitempty"`
}

The ValidatePolicyCELRequest message.

func (*ValidatePolicyCELRequest) GetCel ¶ added in v1.15.0 

func (o *ValidatePolicyCELRequest) GetCel() *string

type ValidatePolicyCELResponse ¶ added in v1.15.0 

type ValidatePolicyCELResponse struct {
	// The markers field.
	Markers []Marker `json:"markers,omitempty"`
}

The ValidatePolicyCELResponse message.

func (*ValidatePolicyCELResponse) GetMarkers ¶ added in v1.15.0 

func (o *ValidatePolicyCELResponse) GetMarkers() []Marker

type Wait ¶ added in v1.18.3 

type Wait struct {
	// The WaitCondition message.
	WaitCondition *WaitCondition `json:"condition,omitempty"`
	// The comment to post on first failed check.
	CommentOnFirstWait *string `json:"commentOnFirstWait,omitempty"`
	// The comment to post if we timeout.
	CommentOnTimeout *string `json:"commentOnTimeout,omitempty"`
	// The name of our condition to show on the task details page
	Name            *string `json:"name,omitempty"`
	TimeoutDuration *string `json:"timeoutDuration,omitempty"`
}

Wait - Define a Wait step for a policy to wait on a condition to be met.

This message contains a oneof named until. Only a single field of the following list may be set at a time:

  • condition

func (*Wait) GetCommentOnFirstWait ¶ added in v1.18.3 

func (o *Wait) GetCommentOnFirstWait() *string

func (*Wait) GetCommentOnTimeout ¶ added in v1.18.3 

func (o *Wait) GetCommentOnTimeout() *string

func (*Wait) GetName ¶ added in v1.18.3 

func (o *Wait) GetName() *string

func (*Wait) GetTimeoutDuration ¶ added in v1.18.3 

func (o *Wait) GetTimeoutDuration() *string

func (*Wait) GetWaitCondition ¶ added in v1.18.3 

func (o *Wait) GetWaitCondition() *WaitCondition

type WaitCondition ¶ added in v1.18.3 

type WaitCondition struct {
	// The condition that has to be true for this wait condition to continue.
	Condition *string `json:"condition,omitempty"`
}

The WaitCondition message.

func (*WaitCondition) GetCondition ¶ added in v1.18.3 

func (o *WaitCondition) GetCondition() *string

type WaitConditionInstance ¶ added in v1.18.3 

type WaitConditionInstance struct {
	// The condition that has to be true for this wait condition instance to continue.
	Condition *string `json:"condition,omitempty"`
}

WaitConditionInstance - Used by the policy engine to describe an instantiated condition to wait on.

func (*WaitConditionInstance) GetCondition ¶ added in v1.18.3 

func (o *WaitConditionInstance) GetCondition() *string

type WaitInstance ¶ added in v1.18.3 

type WaitInstance struct {
	// The ConditionSucceeded message.
	ConditionSucceeded *ConditionSucceeded `json:"succeeded,omitempty"`
	// The ConditionTimedOut message.
	ConditionTimedOut *ConditionTimedOut `json:"timedOut,omitempty"`
	// Used by the policy engine to describe an instantiated condition to wait on.
	WaitConditionInstance *WaitConditionInstance `json:"condition,omitempty"`
	// The comment to post on first failed check.
	CommentOnFirstWait *string `json:"commentOnFirstWait,omitempty"`
	// The comment to post if we timeout.
	CommentOnTimeout *string `json:"commentOnTimeout,omitempty"`
	// The name field.
	Name             *string    `json:"name,omitempty"`
	StartedWaitingAt *time.Time `json:"startedWaitingAt,omitempty"`
	// The state field.
	State           *WaitInstanceState `json:"state,omitempty"`
	Timeout         *time.Time         `json:"timeout,omitempty"`
	TimeoutDuration *string            `json:"timeoutDuration,omitempty"`
}

WaitInstance - Used by the policy engine to describe an instantiated wait step.

This message contains a oneof named until. Only a single field of the following list may be set at a time:

  • condition

This message contains a oneof named outcome. Only a single field of the following list may be set at a time:

  • succeeded
  • timedOut

func (*WaitInstance) GetCommentOnFirstWait ¶ added in v1.18.3 

func (o *WaitInstance) GetCommentOnFirstWait() *string

func (*WaitInstance) GetCommentOnTimeout ¶ added in v1.18.3 

func (o *WaitInstance) GetCommentOnTimeout() *string

func (*WaitInstance) GetConditionSucceeded ¶ added in v1.18.3 

func (o *WaitInstance) GetConditionSucceeded() *ConditionSucceeded

func (*WaitInstance) GetConditionTimedOut ¶ added in v1.18.3 

func (o *WaitInstance) GetConditionTimedOut() *ConditionTimedOut

func (*WaitInstance) GetName ¶ added in v1.18.3 

func (o *WaitInstance) GetName() *string

func (*WaitInstance) GetStartedWaitingAt ¶ added in v1.18.3 

func (o *WaitInstance) GetStartedWaitingAt() *time.Time

func (*WaitInstance) GetState ¶ added in v1.18.3 

func (o *WaitInstance) GetState() *WaitInstanceState

func (*WaitInstance) GetTimeout ¶ added in v1.18.3 

func (o *WaitInstance) GetTimeout() *time.Time

func (*WaitInstance) GetTimeoutDuration ¶ added in v1.18.3 

func (o *WaitInstance) GetTimeoutDuration() *string

func (*WaitInstance) GetWaitConditionInstance ¶ added in v1.18.3 

func (o *WaitInstance) GetWaitConditionInstance() *WaitConditionInstance

func (WaitInstance) MarshalJSON ¶ added in v1.18.3 

func (w WaitInstance) MarshalJSON() ([]byte, error)

func (*WaitInstance) UnmarshalJSON ¶ added in v1.18.3 

func (w *WaitInstance) UnmarshalJSON(data []byte) error

type WaitInstanceState ¶ added in v1.18.3 

type WaitInstanceState string

WaitInstanceState - The state field. 

const (
	WaitInstanceStateWaitInstanceStateUnspecified WaitInstanceState = "WAIT_INSTANCE_STATE_UNSPECIFIED"
	WaitInstanceStateWaitInstanceStateWaiting     WaitInstanceState = "WAIT_INSTANCE_STATE_WAITING"
	WaitInstanceStateWaitInstanceStateCompleted   WaitInstanceState = "WAIT_INSTANCE_STATE_COMPLETED"
	WaitInstanceStateWaitInstanceStateTimedOut    WaitInstanceState = "WAIT_INSTANCE_STATE_TIMED_OUT"
)

func (WaitInstanceState) ToPointer ¶ added in v1.18.3 

func (e WaitInstanceState) ToPointer() *WaitInstanceState

type Webhook ¶ added in v1.18.3 

type Webhook struct {
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	DeletedAt *time.Time `json:"deletedAt,omitempty"`
	// The description field.
	Description *string `json:"description,omitempty"`
	// The displayName field.
	DisplayName *string `json:"displayName,omitempty"`
	// The id field.
	ID        *string    `json:"id,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	// The url field.
	URL *string `json:"url,omitempty"`
}

The Webhook message.

func (*Webhook) GetCreatedAt ¶ added in v1.18.3 

func (o *Webhook) GetCreatedAt() *time.Time

func (*Webhook) GetDeletedAt ¶ added in v1.18.3 

func (o *Webhook) GetDeletedAt() *time.Time

func (*Webhook) GetDescription ¶ added in v1.18.3 

func (o *Webhook) GetDescription() *string

func (*Webhook) GetDisplayName ¶ added in v1.18.3 

func (o *Webhook) GetDisplayName() *string

func (*Webhook) GetID ¶ added in v1.18.3 

func (o *Webhook) GetID() *string

func (*Webhook) GetURL ¶ added in v1.18.3 

func (o *Webhook) GetURL() *string

func (*Webhook) GetUpdatedAt ¶ added in v1.18.3 

func (o *Webhook) GetUpdatedAt() *time.Time

func (Webhook) MarshalJSON ¶ added in v1.18.3 

func (w Webhook) MarshalJSON() ([]byte, error)

func (*Webhook) UnmarshalJSON ¶ added in v1.18.3 

func (w *Webhook) UnmarshalJSON(data []byte) error

type WebhookApproval ¶ added in v1.18.3 

type WebhookApproval struct {
	// The ID of the webhook to call for approval.
	WebhookID *string `json:"webhookId,omitempty"`
}

The WebhookApproval message.

func (*WebhookApproval) GetWebhookID ¶ added in v1.18.3 

func (o *WebhookApproval) GetWebhookID() *string

type WebhookInput ¶ added in v1.18.3 

type WebhookInput struct {
	// The description field.
	Description *string `json:"description,omitempty"`
	// The displayName field.
	DisplayName *string `json:"displayName,omitempty"`
	// The id field.
	ID *string `json:"id,omitempty"`
	// The url field.
	URL *string `json:"url,omitempty"`
}

WebhookInput - The Webhook message.

func (*WebhookInput) GetDescription ¶ added in v1.18.3 

func (o *WebhookInput) GetDescription() *string

func (*WebhookInput) GetDisplayName ¶ added in v1.18.3 

func (o *WebhookInput) GetDisplayName() *string

func (*WebhookInput) GetID ¶ added in v1.18.3 

func (o *WebhookInput) GetID() *string

func (*WebhookInput) GetURL ¶ added in v1.18.3 

func (o *WebhookInput) GetURL() *string

type WebhookInstance ¶ added in v1.18.3 

type WebhookInstance struct {
	// The WebhookSource message.
	//
	// This message contains a oneof named source. Only a single field of the following list may be set at a time:
	//   - test
	//   - policyPostAction
	//   - approvalStep
	//   - provisionStep
	//
	WebhookSource *WebhookSource `json:"source,omitempty"`
	// The WebhookSpec message.
	WebhookSpec *WebhookSpec `json:"spec,omitempty"`
	// The attempts field.
	Attempts    *int       `json:"attempts,omitempty"`
	CompletedAt *time.Time `json:"completedAt,omitempty"`
	CreatedAt   *time.Time `json:"createdAt,omitempty"`
	ExpiresAt   *time.Time `json:"expiresAt,omitempty"`
	// The id field.
	ID              *string    `json:"id,omitempty"`
	LastAttemptedAt *time.Time `json:"lastAttemptedAt,omitempty"`
	// The state field.
	State     *WebhookInstanceState `json:"state,omitempty"`
	UpdatedAt *time.Time            `json:"updatedAt,omitempty"`
	// The webhookId field.
	WebhookID *string `json:"webhookId,omitempty"`
}

The WebhookInstance message.

func (*WebhookInstance) GetAttempts ¶ added in v1.18.3 

func (o *WebhookInstance) GetAttempts() *int

func (*WebhookInstance) GetCompletedAt ¶ added in v1.18.3 

func (o *WebhookInstance) GetCompletedAt() *time.Time

func (*WebhookInstance) GetCreatedAt ¶ added in v1.18.3 

func (o *WebhookInstance) GetCreatedAt() *time.Time

func (*WebhookInstance) GetExpiresAt ¶ added in v1.18.3 

func (o *WebhookInstance) GetExpiresAt() *time.Time

func (*WebhookInstance) GetID ¶ added in v1.18.3 

func (o *WebhookInstance) GetID() *string

func (*WebhookInstance) GetLastAttemptedAt ¶ added in v1.18.3 

func (o *WebhookInstance) GetLastAttemptedAt() *time.Time

func (*WebhookInstance) GetState ¶ added in v1.18.3 

func (o *WebhookInstance) GetState() *WebhookInstanceState

func (*WebhookInstance) GetUpdatedAt ¶ added in v1.18.3 

func (o *WebhookInstance) GetUpdatedAt() *time.Time

func (*WebhookInstance) GetWebhookID ¶ added in v1.18.3 

func (o *WebhookInstance) GetWebhookID() *string

func (*WebhookInstance) GetWebhookSource ¶ added in v1.18.3 

func (o *WebhookInstance) GetWebhookSource() *WebhookSource

func (*WebhookInstance) GetWebhookSpec ¶ added in v1.18.3 

func (o *WebhookInstance) GetWebhookSpec() *WebhookSpec

func (WebhookInstance) MarshalJSON ¶ added in v1.18.3 

func (w WebhookInstance) MarshalJSON() ([]byte, error)

func (*WebhookInstance) UnmarshalJSON ¶ added in v1.18.3 

func (w *WebhookInstance) UnmarshalJSON(data []byte) error

type WebhookInstanceState ¶ added in v1.18.3 

type WebhookInstanceState string

WebhookInstanceState - The state field. 

const (
	WebhookInstanceStateWebhookStateUnspecified     WebhookInstanceState = "WEBHOOK_STATE_UNSPECIFIED"
	WebhookInstanceStateWebhookStatePending         WebhookInstanceState = "WEBHOOK_STATE_PENDING"
	WebhookInstanceStateWebhookStateRunning         WebhookInstanceState = "WEBHOOK_STATE_RUNNING"
	WebhookInstanceStateWebhookStateError           WebhookInstanceState = "WEBHOOK_STATE_ERROR"
	WebhookInstanceStateWebhookStateWaitingCallback WebhookInstanceState = "WEBHOOK_STATE_WAITING_CALLBACK"
	WebhookInstanceStateWebhookStateProcessResponse WebhookInstanceState = "WEBHOOK_STATE_PROCESS_RESPONSE"
	WebhookInstanceStateWebhookStateSuccess         WebhookInstanceState = "WEBHOOK_STATE_SUCCESS"
	WebhookInstanceStateWebhookStateFatalError      WebhookInstanceState = "WEBHOOK_STATE_FATAL_ERROR"
)

func (WebhookInstanceState) ToPointer ¶ added in v1.18.3 

func (e WebhookInstanceState) ToPointer() *WebhookInstanceState

type WebhookProvision ¶ added in v1.18.3 

type WebhookProvision struct {
	// The ID of the webhook to call for provisioning.
	WebhookID *string `json:"webhookId,omitempty"`
}

WebhookProvision - This provision step indicates that a webhook should be called to provision this entitlement.

func (*WebhookProvision) GetWebhookID ¶ added in v1.18.3 

func (o *WebhookProvision) GetWebhookID() *string

type WebhookRef ¶ added in v1.18.3 

type WebhookRef struct {
	// The id field.
	ID *string `json:"id,omitempty"`
}

The WebhookRef message.

func (*WebhookRef) GetID ¶ added in v1.18.3 

func (o *WebhookRef) GetID() *string

type WebhookSource ¶ added in v1.18.3 

type WebhookSource struct {
	// The WebhookSourceApprovalStep message.
	WebhookSourceApprovalStep *WebhookSourceApprovalStep `json:"approvalStep,omitempty"`
	// The WebhookSourcePolicyPostAction message.
	WebhookSourcePolicyPostAction *WebhookSourcePolicyPostAction `json:"policyPostAction,omitempty"`
	// The WebhookSourceProvisionStep message.
	WebhookSourceProvisionStep *WebhookSourceProvisionStep `json:"provisionStep,omitempty"`
	// The WebhookSourceTest message.
	WebhookSourceTest *WebhookSourceTest `json:"test,omitempty"`
}

The WebhookSource message.

This message contains a oneof named source. Only a single field of the following list may be set at a time:

  • test
  • policyPostAction
  • approvalStep
  • provisionStep

func (*WebhookSource) GetWebhookSourceApprovalStep ¶ added in v1.18.3 

func (o *WebhookSource) GetWebhookSourceApprovalStep() *WebhookSourceApprovalStep

func (*WebhookSource) GetWebhookSourcePolicyPostAction ¶ added in v1.18.3 

func (o *WebhookSource) GetWebhookSourcePolicyPostAction() *WebhookSourcePolicyPostAction

func (*WebhookSource) GetWebhookSourceProvisionStep ¶ added in v1.18.3 

func (o *WebhookSource) GetWebhookSourceProvisionStep() *WebhookSourceProvisionStep

func (*WebhookSource) GetWebhookSourceTest ¶ added in v1.18.3 

func (o *WebhookSource) GetWebhookSourceTest() *WebhookSourceTest

type WebhookSourceApprovalStep ¶ added in v1.18.3 

type WebhookSourceApprovalStep struct {
	// The ticketId field.
	TicketID *string `json:"ticketId,omitempty"`
}

The WebhookSourceApprovalStep message.

func (*WebhookSourceApprovalStep) GetTicketID ¶ added in v1.18.3 

func (o *WebhookSourceApprovalStep) GetTicketID() *string

type WebhookSourcePolicyPostAction ¶ added in v1.18.3 

type WebhookSourcePolicyPostAction struct {
	// The ticketId field.
	TicketID *string `json:"ticketId,omitempty"`
}

The WebhookSourcePolicyPostAction message.

func (*WebhookSourcePolicyPostAction) GetTicketID ¶ added in v1.18.3 

func (o *WebhookSourcePolicyPostAction) GetTicketID() *string

type WebhookSourceProvisionStep ¶ added in v1.18.3 

type WebhookSourceProvisionStep struct {
	// The ticketId field.
	TicketID *string `json:"ticketId,omitempty"`
}

The WebhookSourceProvisionStep message.

func (*WebhookSourceProvisionStep) GetTicketID ¶ added in v1.18.3 

func (o *WebhookSourceProvisionStep) GetTicketID() *string

type WebhookSourceTest ¶ added in v1.18.3 

type WebhookSourceTest struct {
}

The WebhookSourceTest message.

type WebhookSpec ¶ added in v1.18.3 

type WebhookSpec struct {
	// The destination field.
	Destination *string `json:"destination,omitempty"`
}

The WebhookSpec message.

func (*WebhookSpec) GetDestination ¶ added in v1.18.3 

func (o *WebhookSpec) GetDestination() *string

type WebhooksSearchRequest ¶ added in v1.18.3 

type WebhooksSearchRequest struct {
	// The pageSize field.
	PageSize *int `json:"pageSize,omitempty"`
	// The pageToken field.
	PageToken *string `json:"pageToken,omitempty"`
	// The query field.
	Query *string `json:"query,omitempty"`
	// The refs field.
	Refs []WebhookRef `json:"refs,omitempty"`
}

The WebhooksSearchRequest message.

func (*WebhooksSearchRequest) GetPageSize ¶ added in v1.18.3 

func (o *WebhooksSearchRequest) GetPageSize() *int

func (*WebhooksSearchRequest) GetPageToken ¶ added in v1.18.3 

func (o *WebhooksSearchRequest) GetPageToken() *string

func (*WebhooksSearchRequest) GetQuery ¶ added in v1.18.3 

func (o *WebhooksSearchRequest) GetQuery() *string

func (*WebhooksSearchRequest) GetRefs ¶ added in v1.18.3 

func (o *WebhooksSearchRequest) GetRefs() []WebhookRef

type WebhooksSearchResponse ¶ added in v1.18.3 

type WebhooksSearchResponse struct {
	// The list field.
	List []Webhook `json:"list,omitempty"`
	// The nextPageToken field.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The WebhooksSearchResponse message.

func (*WebhooksSearchResponse) GetList ¶ added in v1.18.3 

func (o *WebhooksSearchResponse) GetList() []Webhook

func (*WebhooksSearchResponse) GetNextPageToken ¶ added in v1.18.3 

func (o *WebhooksSearchResponse) GetNextPageToken() *string

type WebhooksServiceCreateRequest ¶ added in v1.18.3 

type WebhooksServiceCreateRequest struct {
	// The description field.
	Description *string `json:"description,omitempty"`
	// The displayName field.
	DisplayName *string `json:"displayName,omitempty"`
	// The url field.
	URL *string `json:"url,omitempty"`
}

The WebhooksServiceCreateRequest message.

func (*WebhooksServiceCreateRequest) GetDescription ¶ added in v1.18.3 

func (o *WebhooksServiceCreateRequest) GetDescription() *string

func (*WebhooksServiceCreateRequest) GetDisplayName ¶ added in v1.18.3 

func (o *WebhooksServiceCreateRequest) GetDisplayName() *string

func (*WebhooksServiceCreateRequest) GetURL ¶ added in v1.18.3 

func (o *WebhooksServiceCreateRequest) GetURL() *string

type WebhooksServiceCreateResponse ¶ added in v1.18.3 

type WebhooksServiceCreateResponse struct {
	// The Webhook message.
	Webhook *Webhook `json:"webhook,omitempty"`
}

The WebhooksServiceCreateResponse message.

func (*WebhooksServiceCreateResponse) GetWebhook ¶ added in v1.18.3 

func (o *WebhooksServiceCreateResponse) GetWebhook() *Webhook

type WebhooksServiceDeleteRequest ¶ added in v1.18.3 

type WebhooksServiceDeleteRequest struct {
}

The WebhooksServiceDeleteRequest message.

type WebhooksServiceDeleteResponse ¶ added in v1.18.3 

type WebhooksServiceDeleteResponse struct {
}

WebhooksServiceDeleteResponse - Empty response body. Status code indicates success.

type WebhooksServiceGetResponse ¶ added in v1.18.3 

type WebhooksServiceGetResponse struct {
	// The Webhook message.
	Webhook *Webhook `json:"webhook,omitempty"`
}

The WebhooksServiceGetResponse message.

func (*WebhooksServiceGetResponse) GetWebhook ¶ added in v1.18.3 

func (o *WebhooksServiceGetResponse) GetWebhook() *Webhook

type WebhooksServiceListResponse ¶ added in v1.18.3 

type WebhooksServiceListResponse struct {
	// The list field.
	List []Webhook `json:"list,omitempty"`
	// The nextPageToken field.
	NextPageToken *string `json:"nextPageToken,omitempty"`
}

The WebhooksServiceListResponse message.

func (*WebhooksServiceListResponse) GetList ¶ added in v1.18.3 

func (o *WebhooksServiceListResponse) GetList() []Webhook

func (*WebhooksServiceListResponse) GetNextPageToken ¶ added in v1.18.3 

func (o *WebhooksServiceListResponse) GetNextPageToken() *string

type WebhooksServiceTestRequest ¶ added in v1.18.3 

type WebhooksServiceTestRequest struct {
}

The WebhooksServiceTestRequest message.

type WebhooksServiceTestResponse ¶ added in v1.18.3 

type WebhooksServiceTestResponse struct {
	// The WebhookInstance message.
	WebhookInstance *WebhookInstance `json:"webhook,omitempty"`
}

The WebhooksServiceTestResponse message.

func (*WebhooksServiceTestResponse) GetWebhookInstance ¶ added in v1.18.3 

func (o *WebhooksServiceTestResponse) GetWebhookInstance() *WebhookInstance

type WebhooksServiceUpdateRequest ¶ added in v1.18.3 

type WebhooksServiceUpdateRequest struct {
	// The Webhook message.
	Webhook    *WebhookInput `json:"webhook,omitempty"`
	UpdateMask *string       `json:"updateMask,omitempty"`
}

The WebhooksServiceUpdateRequest message contains the webhook object to update and a field mask to indicate which fields to update. It uses URL value for input.

func (*WebhooksServiceUpdateRequest) GetUpdateMask ¶ added in v1.18.3 

func (o *WebhooksServiceUpdateRequest) GetUpdateMask() *string

func (*WebhooksServiceUpdateRequest) GetWebhook ¶ added in v1.18.3 

func (o *WebhooksServiceUpdateRequest) GetWebhook() *WebhookInput

type WebhooksServiceUpdateResponse ¶ added in v1.18.3 

type WebhooksServiceUpdateResponse struct {
	// The Webhook message.
	Webhook *Webhook `json:"webhook,omitempty"`
}

The WebhooksServiceUpdateResponse message.

func (*WebhooksServiceUpdateResponse) GetWebhook ¶ added in v1.18.3 

func (o *WebhooksServiceUpdateResponse) GetWebhook() *Webhook

Source Files ¶

View all Source files

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.