shared

package
v1.9.0 Latest Latest
Warning

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

 Go to latest Published: Sep 20, 2023 License: MIT Imports: 3 Imported by: 3

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

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 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 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 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 *float64 `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 *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) 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) GetLogoURI ¶ added in v1.6.1 

func (o *App) GetLogoURI() *string

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

func (o *App) GetMonthlyCostUsd() *float64

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() *string

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
	//
	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"`
	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 *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"`
	// 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"`
	// This field indicates if this is a system builtin entitlement.
	SystemBuiltin *bool      `json:"systemBuiltin,omitempty"`
	UpdatedAt     *time.Time `json:"updatedAt,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) 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() *string

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) GetProvisionPolicy ¶ added in v1.6.1 

func (o *AppEntitlement) GetProvisionPolicy() *ProvisionPolicy

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) 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

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
	//
	ProvisionPolicy *ProvisionPolicy `json:"provisionerPolicy,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"`
	// 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"`
	// 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"`
}

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) 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) 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) GetProvisionPolicy ¶ added in v1.7.0 

func (o *AppEntitlementInput) GetProvisionPolicy() *ProvisionPolicy

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

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"`
	// 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"`
	// 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 *float64 `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"`
	// Search for app entitlements that are for items on these resource types.
	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) GetIncludeDeleted ¶ added in v1.9.0 

func (o *AppEntitlementSearchServiceSearchRequest) GetIncludeDeleted() *bool

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() *float64

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) 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 []map[string]interface{} `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() []map[string]interface{}

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

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

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 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 conatins 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 AppGroupApprovalInput ¶ added in v1.8.0 

type AppGroupApprovalInput struct {
}

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

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 cost of an app per-seat, so that total cost can be calculated by the grant count.
	MonthlyCostUsd *float64 `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) GetMonthlyCostUsd ¶ added in v1.7.0 

func (o *AppInput) GetMonthlyCostUsd() *float64

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

func (o *AppInput) GetRevokePolicyID() *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 AppOwnerApprovalInput ¶ added in v1.8.0 

type AppOwnerApprovalInput struct {
}

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

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

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

func (*AppPopulationReportState) UnmarshalJSON ¶ added in v1.0.3 

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

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 *string `json:"grantCount,omitempty"`
	// The id of the resource.
	ID        *string    `json:"id,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() *string

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

func (o *AppResource) GetID() *string

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

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

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 []map[string]interface{} `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() []map[string]interface{}

type AppResourceServiceListResponse ¶ added in v1.0.3 

type AppResourceServiceListResponse struct {
	// List of serialized related objects.
	Expanded []map[string]interface{} `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() []map[string]interface{}

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 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

type AppResourceTypeServiceGetResponse ¶ added in v1.0.3 

type AppResourceTypeServiceGetResponse struct {
	// The AppResourceTypeView message.
	AppResourceTypeView *AppResourceTypeView `json:"appResourceTypeView,omitempty"`
	// List of serialized related objects.
	Expanded []map[string]interface{} `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() []map[string]interface{}

type AppResourceTypeServiceListResponse ¶ added in v1.1.1 

type AppResourceTypeServiceListResponse struct {
	// List of serialized related objects.
	Expanded []map[string]interface{} `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() []map[string]interface{}

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 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 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) 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 *float64 `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 *float64 `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() *float64

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() *float64

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 *AppUserAppUserType `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"`
	// 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]interface{} `json:"profile,omitempty"`
	UpdatedAt      *time.Time             `json:"updatedAt,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() *AppUserAppUserType

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) 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]interface{}

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

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

type AppUserAppUserType ¶ added in v1.7.0 

type AppUserAppUserType string

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

const (
	AppUserAppUserTypeAppUserTypeUnspecified    AppUserAppUserType = "APP_USER_TYPE_UNSPECIFIED"
	AppUserAppUserTypeAppUserTypeUser           AppUserAppUserType = "APP_USER_TYPE_USER"
	AppUserAppUserTypeAppUserTypeServiceAccount AppUserAppUserType = "APP_USER_TYPE_SERVICE_ACCOUNT"
	AppUserAppUserTypeAppUserTypeSystemAccount  AppUserAppUserType = "APP_USER_TYPE_SYSTEM_ACCOUNT"
)

func (AppUserAppUserType) ToPointer ¶ added in v1.7.0 

func (e AppUserAppUserType) ToPointer() *AppUserAppUserType

func (*AppUserAppUserType) UnmarshalJSON ¶ added in v1.7.0 

func (e *AppUserAppUserType) 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 *AppUserAppUserType `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() *AppUserAppUserType

type AppUserServiceUpdateRequestInput ¶ added in v1.8.0 

type AppUserServiceUpdateRequestInput 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"`
}

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

func (*AppUserServiceUpdateRequestInput) GetAppUser ¶ added in v1.8.0 

func (o *AppUserServiceUpdateRequestInput) GetAppUser() *AppUserInput

func (*AppUserServiceUpdateRequestInput) GetAppUserExpandMask ¶ added in v1.8.0 

func (o *AppUserServiceUpdateRequestInput) GetAppUserExpandMask() *AppUserExpandMask

func (*AppUserServiceUpdateRequestInput) GetUpdateMask ¶ added in v1.8.0 

func (o *AppUserServiceUpdateRequestInput) 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 []map[string]interface{} `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() []map[string]interface{}

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

func (*AppUserStatusStatus) UnmarshalJSON ¶ added in v1.7.0 

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

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 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"`
	// 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 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

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) GetRequireReassignmentReason ¶ added in v1.6.1 

func (o *Approval) GetRequireReassignmentReason() *bool

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

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 *AppGroupApprovalInput `json:"group,omitempty"`
	// App owner approval provides the configuration for an approval step when the app owner is the target.
	AppOwnerApproval *AppOwnerApprovalInput `json:"appOwners,omitempty"`
	// The entitlement owner approval allows configuration of the approval step when the target approvers are the entitlement owners.
	EntitlementOwnerApproval *EntitlementOwnerApprovalInput `json:"entitlementOwners,omitempty"`
	// The ExpressionApproval message.
	ExpressionApproval *ExpressionApprovalInput `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 self approval object describes the configuration of a policy step that needs to be approved by the target of the request.
	SelfApproval *SelfApprovalInput `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 *UserApprovalInput `json:"users,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

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

func (o *ApprovalInput) GetAppGroupApproval() *AppGroupApprovalInput

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

func (o *ApprovalInput) GetAppOwnerApproval() *AppOwnerApprovalInput

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

func (o *ApprovalInput) GetEntitlementOwnerApproval() *EntitlementOwnerApprovalInput

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

func (o *ApprovalInput) GetExpressionApproval() *ExpressionApprovalInput

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

func (o *ApprovalInput) GetManagerApproval() *ManagerApprovalInput

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

func (o *ApprovalInput) GetSelfApproval() *SelfApprovalInput

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

func (o *ApprovalInput) GetUserApproval() *UserApprovalInput

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
	//
	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

func (*ApprovalInstanceState) UnmarshalJSON ¶ added in v1.0.3 

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

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

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

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

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

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    map[string]interface{} `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() map[string]interface{}

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

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

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 map[string]interface{} `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() map[string]interface{}

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 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) 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 map[string]interface{} `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() map[string]interface{}

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 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 []map[string]interface{} `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() []map[string]interface{}

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 []map[string]interface{} `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() []map[string]interface{}

type ConnectorServiceListResponse ¶ added in v1.7.0 

type ConnectorServiceListResponse struct {
	// List of serialized related objects
	Expanded []map[string]interface{} `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() []map[string]interface{}

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 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 ConnectorServiceUpdateDelegatedRequestInput ¶ added in v1.7.0 

type ConnectorServiceUpdateDelegatedRequestInput 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"`
}

ConnectorServiceUpdateDelegatedRequestInput - The ConnectorServiceUpdateDelegatedRequest message contains the fields required to update a connector.

func (*ConnectorServiceUpdateDelegatedRequestInput) GetConnector ¶ added in v1.7.0 

func (o *ConnectorServiceUpdateDelegatedRequestInput) GetConnector() *ConnectorInput

func (*ConnectorServiceUpdateDelegatedRequestInput) GetConnectorExpandMask ¶ added in v1.7.0 

func (o *ConnectorServiceUpdateDelegatedRequestInput) GetConnectorExpandMask() *ConnectorExpandMask

func (*ConnectorServiceUpdateDelegatedRequestInput) GetUpdateMask ¶ added in v1.7.0 

func (o *ConnectorServiceUpdateDelegatedRequestInput) GetUpdateMask() *string

type ConnectorServiceUpdateRequestInput ¶ added in v1.7.0 

type ConnectorServiceUpdateRequestInput 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"`
}

ConnectorServiceUpdateRequestInput - The ConnectorServiceUpdateRequest message contains the fields required to update a connector.

func (*ConnectorServiceUpdateRequestInput) GetConnector ¶ added in v1.7.0 

func (o *ConnectorServiceUpdateRequestInput) GetConnector() *ConnectorInput

func (*ConnectorServiceUpdateRequestInput) GetConnectorExpandMask ¶ added in v1.7.0 

func (o *ConnectorServiceUpdateRequestInput) GetConnectorExpandMask() *ConnectorExpandMask

func (*ConnectorServiceUpdateRequestInput) GetUpdateMask ¶ added in v1.7.0 

func (o *ConnectorServiceUpdateRequestInput) 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 []map[string]interface{} `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() []map[string]interface{}

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

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"
)

func (ConnectorStatusStatus) ToPointer ¶ added in v1.7.0 

func (e ConnectorStatusStatus) ToPointer() *ConnectorStatusStatus

func (*ConnectorStatusStatus) UnmarshalJSON ¶ added in v1.7.0 

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

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 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 *float64 `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() *float64

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 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]PolicySteps `json:"policySteps,omitempty"`
	// The enum of the policy type.
	PolicyType *CreatePolicyRequestPolicyType `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 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]PolicySteps

func (*CreatePolicyRequest) GetPolicyType ¶ added in v1.6.1 

func (o *CreatePolicyRequest) GetPolicyType() *CreatePolicyRequestPolicyType

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

type CreatePolicyRequestInput ¶ added in v1.7.0 

type CreatePolicyRequestInput 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 *CreatePolicyRequestPolicyType `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"`
}

CreatePolicyRequestInput - The CreatePolicyRequest message is used to create a new policy.

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

func (o *CreatePolicyRequestInput) GetDescription() *string

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

func (o *CreatePolicyRequestInput) GetDisplayName() *string

func (*CreatePolicyRequestInput) GetPolicySteps ¶ added in v1.7.0 

func (o *CreatePolicyRequestInput) GetPolicySteps() map[string]PolicyStepsInput

func (*CreatePolicyRequestInput) GetPolicyType ¶ added in v1.7.0 

func (o *CreatePolicyRequestInput) GetPolicyType() *CreatePolicyRequestPolicyType

func (*CreatePolicyRequestInput) GetPostActions ¶ added in v1.7.0 

func (o *CreatePolicyRequestInput) GetPostActions() []PolicyPostActions

func (*CreatePolicyRequestInput) GetReassignTasksToDelegates ¶ added in v1.7.0 

func (o *CreatePolicyRequestInput) GetReassignTasksToDelegates() *bool

type CreatePolicyRequestPolicyType ¶ added in v1.0.3 

type CreatePolicyRequestPolicyType string

CreatePolicyRequestPolicyType - The enum of the policy type. 

const (
	CreatePolicyRequestPolicyTypePolicyTypeUnspecified   CreatePolicyRequestPolicyType = "POLICY_TYPE_UNSPECIFIED"
	CreatePolicyRequestPolicyTypePolicyTypeGrant         CreatePolicyRequestPolicyType = "POLICY_TYPE_GRANT"
	CreatePolicyRequestPolicyTypePolicyTypeRevoke        CreatePolicyRequestPolicyType = "POLICY_TYPE_REVOKE"
	CreatePolicyRequestPolicyTypePolicyTypeCertify       CreatePolicyRequestPolicyType = "POLICY_TYPE_CERTIFY"
	CreatePolicyRequestPolicyTypePolicyTypeAccessRequest CreatePolicyRequestPolicyType = "POLICY_TYPE_ACCESS_REQUEST"
	CreatePolicyRequestPolicyTypePolicyTypeProvision     CreatePolicyRequestPolicyType = "POLICY_TYPE_PROVISION"
)

func (CreatePolicyRequestPolicyType) ToPointer ¶ added in v1.0.3 

func (e CreatePolicyRequestPolicyType) ToPointer() *CreatePolicyRequestPolicyType

func (*CreatePolicyRequestPolicyType) UnmarshalJSON ¶ added in v1.0.3 

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

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 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"`
}

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

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 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

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

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 []map[string]interface{} `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() []map[string]interface{}

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 []map[string]interface{} `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() []map[string]interface{}

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 []map[string]interface{} `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() []map[string]interface{}

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 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 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 EntitlementOwnerApprovalInput ¶ added in v1.8.0 

type EntitlementOwnerApprovalInput struct {
}

EntitlementOwnerApprovalInput - The entitlement owner approval allows configuration of the approval step when the target approvers are the entitlement owners.

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

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 ExpressionApprovalInput ¶ added in v1.9.0 

type ExpressionApprovalInput struct {
}

ExpressionApprovalInput - The ExpressionApproval message.

type ExternalRef ¶ added in v1.0.3 

type ExternalRef struct {
	// The source of the external reference.
	ExternalRefSource *ExternalRefExternalRefSource `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() *ExternalRefExternalRefSource

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 ExternalRefExternalRefSource ¶ added in v1.0.3 

type ExternalRefExternalRefSource string

ExternalRefExternalRefSource - The source of the external reference. 

const (
	ExternalRefExternalRefSourceUnspecified ExternalRefExternalRefSource = "UNSPECIFIED"
	ExternalRefExternalRefSourceJira        ExternalRefExternalRefSource = "JIRA"
)

func (ExternalRefExternalRefSource) ToPointer ¶ added in v1.0.3 

func (e ExternalRefExternalRefSource) ToPointer() *ExternalRefExternalRefSource

func (*ExternalRefExternalRefSource) UnmarshalJSON ¶ added in v1.0.3 

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

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 *string `json:"count,omitempty"`
	// The display name of the range.
	DisplayName *string `json:"displayName,omitempty"`
	// The starting value of the range.
	From *string `json:"from,omitempty"`
	// The icon of the range.
	IconURL *string `json:"iconUrl,omitempty"`
	// The ending value of the range.
	To *string `json:"to,omitempty"`
}

The FacetRange message.

func (*FacetRange) GetCount ¶ added in v1.7.0 

func (o *FacetRange) GetCount() *string

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() *string

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() *string

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 *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() *string

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 *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() *string

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

func (o *Facets) GetFacets() []FacetCategory

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 []map[string]interface{} `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() []map[string]interface{}

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 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 []map[string]interface{} `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() []map[string]interface{}

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 ListAppEntitlementsResponse ¶ added in v1.7.0 

type ListAppEntitlementsResponse struct {
	// List of related objects
	Expanded []map[string]interface{} `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() []map[string]interface{}

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 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.
	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 {
}

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.

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 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

type OAuth2AuthorizedAsInput ¶ added in v1.8.0 

type OAuth2AuthorizedAsInput struct {
}

OAuth2AuthorizedAsInput - OAuth2AuthorizedAs tracks the user that OAuthed with the connector.

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

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 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 referrs 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

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 referrs 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
	//
	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

func (*PolicyPolicyType) UnmarshalJSON ¶ added in v1.0.3 

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

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 {
	// 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
	//
	Approval *Approval `json:"approval,omitempty"`
	// The provision step references a provision policy for this step.
	Provision *Provision `json:"provision,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

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

type PolicyStepInput ¶ added in v1.7.0 

type PolicyStepInput 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
	//
	Approval *ApprovalInput `json:"approval,omitempty"`
	// The provision step references a provision policy for this step.
	Provision *Provision `json:"provision,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

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

type PolicyStepInstance ¶ added in v1.0.3 

type PolicyStepInstance struct {
	// 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"`
	// 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

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) GetState ¶ added in v1.6.1 

func (o *PolicyStepInstance) GetState() *PolicyStepInstanceState

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

func (*PolicyStepInstanceState) UnmarshalJSON ¶ added in v1.0.3 

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

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 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
	//
	ProvisionPolicy *ProvisionPolicy `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() *ProvisionPolicy

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"
	ProvisionInstanceStateProvisionInstanceStateDone                            ProvisionInstanceState = "PROVISION_INSTANCE_STATE_DONE"
)

func (ProvisionInstanceState) ToPointer ¶ added in v1.0.3 

func (e ProvisionInstanceState) ToPointer() *ProvisionInstanceState

func (*ProvisionInstanceState) UnmarshalJSON ¶ added in v1.0.3 

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

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"`
	// Manual provisioning indicates that a human must intervene for the provisioning of this step.
	ManualProvision *ManualProvision `json:"manual,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

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) GetManualProvision ¶ added in v1.6.1 

func (o *ProvisionPolicy) GetManualProvision() *ManualProvision

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 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

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

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"`
	// The id of the request catalog.
	ID *string `json:"id,omitempty"`
	// Whether or not this catalog is published.
	Published *bool      `json:"published,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) 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) 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

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"`
	// The id of the request catalog.
	ID *string `json:"id,omitempty"`
	// Whether or not this catalog is published.
	Published *bool `json:"published,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) 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) 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"`
}

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

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 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) 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 []map[string]interface{} `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() []map[string]interface{}

func (*RequestCatalogManagementServiceGetResponse) GetRequestCatalogView ¶ added in v1.6.1 

func (o *RequestCatalogManagementServiceGetResponse) GetRequestCatalogView() *RequestCatalogView

type RequestCatalogManagementServiceListEntitlementsForAccessResponse ¶ added in v1.6.1 

type RequestCatalogManagementServiceListEntitlementsForAccessResponse struct {
	// List of serialized related objects.
	Expanded []map[string]interface{} `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() []map[string]interface{}

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 RequestCatalogManagementServiceListEntitlementsPerCatalogResponse ¶ added in v1.6.1 

type RequestCatalogManagementServiceListEntitlementsPerCatalogResponse struct {
	// List of serialized related objects.
	Expanded []map[string]interface{} `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() []map[string]interface{}

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 RequestCatalogManagementServiceListResponse ¶ added in v1.9.0 

type RequestCatalogManagementServiceListResponse struct {
	// List of serialized related objects.
	Expanded []map[string]interface{} `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() []map[string]interface{}

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 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 RequestCatalogManagementServiceUpdateRequestInput ¶ added in v1.7.0 

type RequestCatalogManagementServiceUpdateRequestInput 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"`
}

RequestCatalogManagementServiceUpdateRequestInput - Update a request catalog object by ID.

func (*RequestCatalogManagementServiceUpdateRequestInput) GetRequestCatalog ¶ added in v1.7.0 

func (o *RequestCatalogManagementServiceUpdateRequestInput) GetRequestCatalog() *RequestCatalogInput

func (*RequestCatalogManagementServiceUpdateRequestInput) GetRequestCatalogExpandMask ¶ added in v1.7.0 

func (o *RequestCatalogManagementServiceUpdateRequestInput) GetRequestCatalogExpandMask() *RequestCatalogExpandMask

func (*RequestCatalogManagementServiceUpdateRequestInput) GetUpdateMask ¶ added in v1.7.0 

func (o *RequestCatalogManagementServiceUpdateRequestInput) 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 *RequestCatalogSearchServiceSearchEntitlementsRequestGrantedStatus `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 *float64 `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() *RequestCatalogSearchServiceSearchEntitlementsRequestGrantedStatus

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() *float64

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 RequestCatalogSearchServiceSearchEntitlementsRequestGrantedStatus ¶ added in v1.5.0 

type RequestCatalogSearchServiceSearchEntitlementsRequestGrantedStatus string

RequestCatalogSearchServiceSearchEntitlementsRequestGrantedStatus - Search entitlements with this granted status for your signed in user. 

const (
	RequestCatalogSearchServiceSearchEntitlementsRequestGrantedStatusUnspecified RequestCatalogSearchServiceSearchEntitlementsRequestGrantedStatus = "UNSPECIFIED"
	RequestCatalogSearchServiceSearchEntitlementsRequestGrantedStatusAll         RequestCatalogSearchServiceSearchEntitlementsRequestGrantedStatus = "ALL"
	RequestCatalogSearchServiceSearchEntitlementsRequestGrantedStatusGranted     RequestCatalogSearchServiceSearchEntitlementsRequestGrantedStatus = "GRANTED"
	RequestCatalogSearchServiceSearchEntitlementsRequestGrantedStatusNotGranted  RequestCatalogSearchServiceSearchEntitlementsRequestGrantedStatus = "NOT_GRANTED"
)

func (RequestCatalogSearchServiceSearchEntitlementsRequestGrantedStatus) ToPointer ¶ added in v1.5.0 

func (e RequestCatalogSearchServiceSearchEntitlementsRequestGrantedStatus) ToPointer() *RequestCatalogSearchServiceSearchEntitlementsRequestGrantedStatus

func (*RequestCatalogSearchServiceSearchEntitlementsRequestGrantedStatus) UnmarshalJSON ¶ added in v1.5.0 

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

type RequestCatalogSearchServiceSearchEntitlementsResponse ¶ added in v1.0.3 

type RequestCatalogSearchServiceSearchEntitlementsResponse struct {
	// The list of results containing up to X results, where X is the page size defined in the request.
	Expanded []map[string]interface{} `json:"expanded,omitempty"`
	// List of serialized related objects.
	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() []map[string]interface{}

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 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"`
}

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) GetRequestCatalog ¶ added in v1.6.1 

func (o *RequestCatalogView) GetRequestCatalog() *RequestCatalog

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

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"`
	// 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) 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

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 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 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 *float64 `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) 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() *float64

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"`
	// 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 *float64 `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) GetPageSize ¶ added in v1.6.1 

func (o *SearchAppsRequest) GetPageSize() *float64

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 *float64 `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() *float64

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 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 pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)
	PageSize *float64 `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 []SearchPoliciesRequestPolicyTypes `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) GetPageSize ¶ added in v1.7.0 

func (o *SearchPoliciesRequest) GetPageSize() *float64

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() []SearchPoliciesRequestPolicyTypes

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 SearchPoliciesRequestPolicyTypes ¶ added in v1.7.0 

type SearchPoliciesRequestPolicyTypes string
const (
	SearchPoliciesRequestPolicyTypesPolicyTypeUnspecified   SearchPoliciesRequestPolicyTypes = "POLICY_TYPE_UNSPECIFIED"
	SearchPoliciesRequestPolicyTypesPolicyTypeGrant         SearchPoliciesRequestPolicyTypes = "POLICY_TYPE_GRANT"
	SearchPoliciesRequestPolicyTypesPolicyTypeRevoke        SearchPoliciesRequestPolicyTypes = "POLICY_TYPE_REVOKE"
	SearchPoliciesRequestPolicyTypesPolicyTypeCertify       SearchPoliciesRequestPolicyTypes = "POLICY_TYPE_CERTIFY"
	SearchPoliciesRequestPolicyTypesPolicyTypeAccessRequest SearchPoliciesRequestPolicyTypes = "POLICY_TYPE_ACCESS_REQUEST"
	SearchPoliciesRequestPolicyTypesPolicyTypeProvision     SearchPoliciesRequestPolicyTypes = "POLICY_TYPE_PROVISION"
)

func (SearchPoliciesRequestPolicyTypes) ToPointer ¶ added in v1.7.0 

func (e SearchPoliciesRequestPolicyTypes) ToPointer() *SearchPoliciesRequestPolicyTypes

func (*SearchPoliciesRequestPolicyTypes) UnmarshalJSON ¶ added in v1.7.0 

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

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 *float64 `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 []SearchUsersRequestUserStatuses `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() *float64

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() []SearchUsersRequestUserStatuses

type SearchUsersRequestUserStatuses ¶ added in v1.0.3 

type SearchUsersRequestUserStatuses string
const (
	SearchUsersRequestUserStatusesUnknown  SearchUsersRequestUserStatuses = "UNKNOWN"
	SearchUsersRequestUserStatusesEnabled  SearchUsersRequestUserStatuses = "ENABLED"
	SearchUsersRequestUserStatusesDisabled SearchUsersRequestUserStatuses = "DISABLED"
	SearchUsersRequestUserStatusesDeleted  SearchUsersRequestUserStatuses = "DELETED"
)

func (SearchUsersRequestUserStatuses) ToPointer ¶ added in v1.0.3 

func (e SearchUsersRequestUserStatuses) ToPointer() *SearchUsersRequestUserStatuses

func (*SearchUsersRequestUserStatuses) UnmarshalJSON ¶ added in v1.0.3 

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

type SearchUsersResponse ¶ added in v1.0.3 

type SearchUsersResponse struct {
	// List of related objects
	Expanded []map[string]interface{} `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() []map[string]interface{}

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 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 SelfApprovalInput ¶ added in v1.8.0 

type SelfApprovalInput struct {
}

SelfApprovalInput - The self approval object describes the configuration of a policy step that needs to be approved by the target of the request.

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 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
	//
	TaskType *TaskType `json:"type,omitempty"`
	// The actions that can be performed on the task by the current user.
	Actions []TaskActions `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 []map[string]interface{} `json:"annotations,omitempty"`
	// The count of comments.
	CommentCount *float64   `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"`
	// 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 *string `json:"numericId,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 *TaskProcessing `json:"processing,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() []TaskActions

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() []map[string]interface{}

func (*Task) GetCommentCount ¶ added in v1.6.1 

func (o *Task) GetCommentCount() *float64

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) GetNumericID ¶ added in v1.6.1 

func (o *Task) GetNumericID() *string

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() *TaskProcessing

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

type TaskActions ¶ added in v1.0.3 

type TaskActions string
const (
	TaskActionsTaskActionTypeUnspecified                              TaskActions = "TASK_ACTION_TYPE_UNSPECIFIED"
	TaskActionsTaskActionTypeClose                                    TaskActions = "TASK_ACTION_TYPE_CLOSE"
	TaskActionsTaskActionTypeApprove                                  TaskActions = "TASK_ACTION_TYPE_APPROVE"
	TaskActionsTaskActionTypeDeny                                     TaskActions = "TASK_ACTION_TYPE_DENY"
	TaskActionsTaskActionTypeComment                                  TaskActions = "TASK_ACTION_TYPE_COMMENT"
	TaskActionsTaskActionTypeDelete                                   TaskActions = "TASK_ACTION_TYPE_DELETE"
	TaskActionsTaskActionTypeReassign                                 TaskActions = "TASK_ACTION_TYPE_REASSIGN"
	TaskActionsTaskActionTypeRestart                                  TaskActions = "TASK_ACTION_TYPE_RESTART"
	TaskActionsTaskActionTypeSendReminder                             TaskActions = "TASK_ACTION_TYPE_SEND_REMINDER"
	TaskActionsTaskActionTypeProvisionComplete                        TaskActions = "TASK_ACTION_TYPE_PROVISION_COMPLETE"
	TaskActionsTaskActionTypeProvisionCancelled                       TaskActions = "TASK_ACTION_TYPE_PROVISION_CANCELLED"
	TaskActionsTaskActionTypeProvisionErrored                         TaskActions = "TASK_ACTION_TYPE_PROVISION_ERRORED"
	TaskActionsTaskActionTypeProvisionAppUserTargetCreated            TaskActions = "TASK_ACTION_TYPE_PROVISION_APP_USER_TARGET_CREATED"
	TaskActionsTaskActionTypeRollbackSkipped                          TaskActions = "TASK_ACTION_TYPE_ROLLBACK_SKIPPED"
	TaskActionsTaskActionTypeHardReset                                TaskActions = "TASK_ACTION_TYPE_HARD_RESET"
	TaskActionsTaskActionTypeEscalateToEmergencyAccess                TaskActions = "TASK_ACTION_TYPE_ESCALATE_TO_EMERGENCY_ACCESS"
	TaskActionsTaskActionTypeChangePolicy                             TaskActions = "TASK_ACTION_TYPE_CHANGE_POLICY"
	TaskActionsTaskActionTypeRecalculateDenialFromBasePolicyDecisions TaskActions = "TASK_ACTION_TYPE_RECALCULATE_DENIAL_FROM_BASE_POLICY_DECISIONS"
)

func (TaskActions) ToPointer ¶ added in v1.0.3 

func (e TaskActions) ToPointer() *TaskActions

func (*TaskActions) UnmarshalJSON ¶ added in v1.0.3 

func (e *TaskActions) 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 []map[string]interface{} `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() []map[string]interface{}

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 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 []map[string]interface{} `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() []map[string]interface{}

func (*TaskActionsServiceCommentResponse) GetTaskView ¶ added in v1.6.1 

func (o *TaskActionsServiceCommentResponse) GetTaskView() *TaskView

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 []map[string]interface{} `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() []map[string]interface{}

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 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 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", and "identity_user_id".
	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 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

type TaskProcessing ¶ added in v1.0.3 

type TaskProcessing string

TaskProcessing - The processing state of a task as defined by the `processing_enum` 

const (
	TaskProcessingTaskProcessingTypeUnspecified TaskProcessing = "TASK_PROCESSING_TYPE_UNSPECIFIED"
	TaskProcessingTaskProcessingTypeProcessing  TaskProcessing = "TASK_PROCESSING_TYPE_PROCESSING"
	TaskProcessingTaskProcessingTypeWaiting     TaskProcessing = "TASK_PROCESSING_TYPE_WAITING"
	TaskProcessingTaskProcessingTypeDone        TaskProcessing = "TASK_PROCESSING_TYPE_DONE"
)

func (TaskProcessing) ToPointer ¶ added in v1.0.3 

func (e TaskProcessing) ToPointer() *TaskProcessing

func (*TaskProcessing) UnmarshalJSON ¶ added in v1.0.3 

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

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

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

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 TaskSearchRequestCurrentStep ¶ added in v1.0.3 

type TaskSearchRequestCurrentStep string

TaskSearchRequestCurrentStep - Search tasks that have this type of step as the current step. 

const (
	TaskSearchRequestCurrentStepTaskSearchCurrentStepUnspecified TaskSearchRequestCurrentStep = "TASK_SEARCH_CURRENT_STEP_UNSPECIFIED"
	TaskSearchRequestCurrentStepTaskSearchCurrentStepApproval    TaskSearchRequestCurrentStep = "TASK_SEARCH_CURRENT_STEP_APPROVAL"
	TaskSearchRequestCurrentStepTaskSearchCurrentStepProvision   TaskSearchRequestCurrentStep = "TASK_SEARCH_CURRENT_STEP_PROVISION"
)

func (TaskSearchRequestCurrentStep) ToPointer ¶ added in v1.0.3 

func (e TaskSearchRequestCurrentStep) ToPointer() *TaskSearchRequestCurrentStep

func (*TaskSearchRequestCurrentStep) UnmarshalJSON ¶ added in v1.0.3 

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

type TaskSearchRequestEmergencyStatus ¶ added in v1.6.0 

type TaskSearchRequestEmergencyStatus string

TaskSearchRequestEmergencyStatus - Search tasks that are or are not emergency access. 

const (
	TaskSearchRequestEmergencyStatusUnspecified  TaskSearchRequestEmergencyStatus = "UNSPECIFIED"
	TaskSearchRequestEmergencyStatusAll          TaskSearchRequestEmergencyStatus = "ALL"
	TaskSearchRequestEmergencyStatusNonEmergency TaskSearchRequestEmergencyStatus = "NON_EMERGENCY"
	TaskSearchRequestEmergencyStatusEmergency    TaskSearchRequestEmergencyStatus = "EMERGENCY"
)

func (TaskSearchRequestEmergencyStatus) ToPointer ¶ added in v1.6.0 

func (e TaskSearchRequestEmergencyStatus) ToPointer() *TaskSearchRequestEmergencyStatus

func (*TaskSearchRequestEmergencyStatus) UnmarshalJSON ¶ added in v1.6.0 

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

type TaskSearchRequestInput ¶ added in v1.7.1 

type TaskSearchRequestInput 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"`
	// 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 *TaskSearchRequestCurrentStep `json:"currentStep,omitempty"`
	// Search tasks that are or are not emergency access.
	EmergencyStatus *TaskSearchRequestEmergencyStatus `json:"emergencyStatus,omitempty"`
	// Search tasks that do not have any of these app entitlement IDs.
	ExcludeAppEntitlementIds []string `json:"excludeAppEntitlementIds,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"`
	// 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 *float64 `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 *TaskSearchRequestSortBy `json:"sortBy,omitempty"`
	// Search tasks where these users are the subject.
	SubjectIds []string `json:"subjectIds,omitempty"`
	// Search tasks with this task state.
	TaskStates []TaskSearchRequestTaskStates `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"`
}

TaskSearchRequestInput - Search for tasks based on a plethora filters.

func (*TaskSearchRequestInput) GetAccessReviewIds ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetAccessReviewIds() []string

func (*TaskSearchRequestInput) GetAccountOwnerIds ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetAccountOwnerIds() []string

func (*TaskSearchRequestInput) GetActorID ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetActorID() *string

func (*TaskSearchRequestInput) GetAppEntitlementIds ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetAppEntitlementIds() []string

func (*TaskSearchRequestInput) GetAppResourceIds ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetAppResourceIds() []string

func (*TaskSearchRequestInput) GetAppResourceTypeIds ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetAppResourceTypeIds() []string

func (*TaskSearchRequestInput) GetAppUserSubjectIds ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetAppUserSubjectIds() []string

func (*TaskSearchRequestInput) GetApplicationIds ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetApplicationIds() []string

func (*TaskSearchRequestInput) GetAssigneesInIds ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetAssigneesInIds() []string

func (*TaskSearchRequestInput) GetCreatedAfter ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetCreatedAfter() *time.Time

func (*TaskSearchRequestInput) GetCreatedBefore ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetCreatedBefore() *time.Time

func (*TaskSearchRequestInput) GetCurrentStep ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetCurrentStep() *TaskSearchRequestCurrentStep

func (*TaskSearchRequestInput) GetEmergencyStatus ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetEmergencyStatus() *TaskSearchRequestEmergencyStatus

func (*TaskSearchRequestInput) GetExcludeAppEntitlementIds ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetExcludeAppEntitlementIds() []string

func (*TaskSearchRequestInput) GetExcludeIds ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetExcludeIds() []string

func (*TaskSearchRequestInput) GetIncludeDeleted ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetIncludeDeleted() *bool

func (*TaskSearchRequestInput) GetMyWorkUserIds ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetMyWorkUserIds() []string

func (*TaskSearchRequestInput) GetOpenerIds ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetOpenerIds() []string

func (*TaskSearchRequestInput) GetPageSize ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetPageSize() *float64

func (*TaskSearchRequestInput) GetPageToken ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetPageToken() *string

func (*TaskSearchRequestInput) GetPreviouslyActedOnIds ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetPreviouslyActedOnIds() []string

func (*TaskSearchRequestInput) GetQuery ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetQuery() *string

func (*TaskSearchRequestInput) GetRefs ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetRefs() []TaskRef

func (*TaskSearchRequestInput) GetSortBy ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetSortBy() *TaskSearchRequestSortBy

func (*TaskSearchRequestInput) GetSubjectIds ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetSubjectIds() []string

func (*TaskSearchRequestInput) GetTaskExpandMask ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetTaskExpandMask() *TaskExpandMask

func (*TaskSearchRequestInput) GetTaskStates ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetTaskStates() []TaskSearchRequestTaskStates

func (*TaskSearchRequestInput) GetTaskTypes ¶ added in v1.7.1 

func (o *TaskSearchRequestInput) GetTaskTypes() []TaskTypeInput

type TaskSearchRequestSortBy ¶ added in v1.0.3 

type TaskSearchRequestSortBy string

TaskSearchRequestSortBy - Sort tasks in a specific order. 

const (
	TaskSearchRequestSortByTaskSearchSortByUnspecified     TaskSearchRequestSortBy = "TASK_SEARCH_SORT_BY_UNSPECIFIED"
	TaskSearchRequestSortByTaskSearchSortByAccount         TaskSearchRequestSortBy = "TASK_SEARCH_SORT_BY_ACCOUNT"
	TaskSearchRequestSortByTaskSearchSortByResource        TaskSearchRequestSortBy = "TASK_SEARCH_SORT_BY_RESOURCE"
	TaskSearchRequestSortByTaskSearchSortByAccountOwner    TaskSearchRequestSortBy = "TASK_SEARCH_SORT_BY_ACCOUNT_OWNER"
	TaskSearchRequestSortByTaskSearchSortByReverseTicketID TaskSearchRequestSortBy = "TASK_SEARCH_SORT_BY_REVERSE_TICKET_ID"
)

func (TaskSearchRequestSortBy) ToPointer ¶ added in v1.0.3 

func (e TaskSearchRequestSortBy) ToPointer() *TaskSearchRequestSortBy

func (*TaskSearchRequestSortBy) UnmarshalJSON ¶ added in v1.0.3 

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

type TaskSearchRequestTaskStates ¶ added in v1.0.3 

type TaskSearchRequestTaskStates string
const (
	TaskSearchRequestTaskStatesTaskStateUnspecified TaskSearchRequestTaskStates = "TASK_STATE_UNSPECIFIED"
	TaskSearchRequestTaskStatesTaskStateOpen        TaskSearchRequestTaskStates = "TASK_STATE_OPEN"
	TaskSearchRequestTaskStatesTaskStateClosed      TaskSearchRequestTaskStates = "TASK_STATE_CLOSED"
)

func (TaskSearchRequestTaskStates) ToPointer ¶ added in v1.0.3 

func (e TaskSearchRequestTaskStates) ToPointer() *TaskSearchRequestTaskStates

func (*TaskSearchRequestTaskStates) UnmarshalJSON ¶ added in v1.0.3 

func (e *TaskSearchRequestTaskStates) 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 []map[string]interface{} `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() []map[string]interface{}

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 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 []map[string]interface{} `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() []map[string]interface{}

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 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 []map[string]interface{} `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() []map[string]interface{}

func (*TaskServiceCreateGrantResponse) GetTaskView ¶ added in v1.6.1 

func (o *TaskServiceCreateGrantResponse) GetTaskView() *TaskView

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 []map[string]interface{} `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() []map[string]interface{}

func (*TaskServiceCreateRevokeResponse) GetTaskView ¶ added in v1.6.1 

func (o *TaskServiceCreateRevokeResponse) GetTaskView() *TaskView

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 []map[string]interface{} `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() []map[string]interface{}

func (*TaskServiceGetResponse) GetTaskView ¶ added in v1.6.1 

func (o *TaskServiceGetResponse) GetTaskView() *TaskView

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

func (*TaskState) UnmarshalJSON ¶ added in v1.0.3 

func (e *TaskState) 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 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

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) 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     *TaskTypeCertifyOutcome `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() *TaskTypeCertifyOutcome

func (*TaskTypeCertify) GetOutcomeTime ¶ added in v1.6.1 

func (o *TaskTypeCertify) GetOutcomeTime() *time.Time

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 TaskTypeCertifyOutcome ¶ added in v1.0.3 

type TaskTypeCertifyOutcome string

TaskTypeCertifyOutcome - The outcome of the certification. 

const (
	TaskTypeCertifyOutcomeCertifyOutcomeUnspecified TaskTypeCertifyOutcome = "CERTIFY_OUTCOME_UNSPECIFIED"
	TaskTypeCertifyOutcomeCertifyOutcomeCertified   TaskTypeCertifyOutcome = "CERTIFY_OUTCOME_CERTIFIED"
	TaskTypeCertifyOutcomeCertifyOutcomeDecertified TaskTypeCertifyOutcome = "CERTIFY_OUTCOME_DECERTIFIED"
	TaskTypeCertifyOutcomeCertifyOutcomeError       TaskTypeCertifyOutcome = "CERTIFY_OUTCOME_ERROR"
	TaskTypeCertifyOutcomeCertifyOutcomeCancelled   TaskTypeCertifyOutcome = "CERTIFY_OUTCOME_CANCELLED"
)

func (TaskTypeCertifyOutcome) ToPointer ¶ added in v1.0.3 

func (e TaskTypeCertifyOutcome) ToPointer() *TaskTypeCertifyOutcome

func (*TaskTypeCertifyOutcome) UnmarshalJSON ¶ added in v1.0.3 

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

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

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"
)

func (TaskTypeGrantOutcome) ToPointer ¶ added in v1.0.3 

func (e TaskTypeGrantOutcome) ToPointer() *TaskTypeGrantOutcome

func (*TaskTypeGrantOutcome) UnmarshalJSON ¶ added in v1.0.3 

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

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 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

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) GetTaskTypeRevoke ¶ added in v1.7.1 

func (o *TaskTypeInput) GetTaskTypeRevoke() *TaskTypeRevokeInput

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

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"
)

func (TaskTypeRevokeOutcome) ToPointer ¶ added in v1.0.3 

func (e TaskTypeRevokeOutcome) ToPointer() *TaskTypeRevokeOutcome

func (*TaskTypeRevokeOutcome) UnmarshalJSON ¶ added in v1.0.3 

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

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 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) 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 UpdateAppEntitlementRequestInput ¶ added in v1.7.0 

type UpdateAppEntitlementRequestInput 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"`
	UpdateMask               *string                   `json:"updateMask,omitempty"`
}

UpdateAppEntitlementRequestInput - The UpdateAppEntitlementRequest message contains the app entitlement and the fields to be updated.

func (*UpdateAppEntitlementRequestInput) GetAppEntitlement ¶ added in v1.7.0 

func (o *UpdateAppEntitlementRequestInput) GetAppEntitlement() *AppEntitlementInput

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

func (o *UpdateAppEntitlementRequestInput) GetAppEntitlementExpandMask() *AppEntitlementExpandMask

func (*UpdateAppEntitlementRequestInput) GetUpdateMask ¶ added in v1.7.0 

func (o *UpdateAppEntitlementRequestInput) 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 []map[string]interface{} `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() []map[string]interface{}

type UpdateAppRequestInput ¶ added in v1.7.0 

type UpdateAppRequestInput 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"`
}

UpdateAppRequestInput - The UpdateAppRequest message contains the app to update and the fields to update.

func (*UpdateAppRequestInput) GetApp ¶ added in v1.7.0 

func (o *UpdateAppRequestInput) GetApp() *AppInput

func (*UpdateAppRequestInput) GetUpdateMask ¶ added in v1.7.0 

func (o *UpdateAppRequestInput) 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 UpdatePolicyRequestInput ¶ added in v1.7.0 

type UpdatePolicyRequestInput 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"`
}

UpdatePolicyRequestInput - 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 (*UpdatePolicyRequestInput) GetPolicy ¶ added in v1.7.0 

func (o *UpdatePolicyRequestInput) GetPolicy() *PolicyInput

func (*UpdatePolicyRequestInput) GetUpdateMask ¶ added in v1.7.0 

func (o *UpdatePolicyRequestInput) 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 UpdateRoleRequestInput ¶ added in v1.7.0 

type UpdateRoleRequestInput struct {
	// Role is a role that can be assigned to a user in ConductorOne.
	Role       *RoleInput `json:"role,omitempty"`
	UpdateMask *string    `json:"updateMask,omitempty"`
}

UpdateRoleRequestInput - The UpdateRoleRequest message contains the role to update and the update mask.

func (*UpdateRoleRequestInput) GetRole ¶ added in v1.7.0 

func (o *UpdateRoleRequestInput) GetRole() *RoleInput

func (*UpdateRoleRequestInput) GetUpdateMask ¶ added in v1.7.0 

func (o *UpdateRoleRequestInput) 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 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 *UserDirectoryStatus `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"`
	// 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"`
	// 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"`
}

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() *UserDirectoryStatus

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) 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) 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

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 UserApprovalInput ¶ added in v1.8.0 

type UserApprovalInput struct {
}

UserApprovalInput - The user approval object describes the approval configuration of a policy step that needs to be approved by a specific list of users.

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 UserDirectoryStatus ¶ added in v1.0.3 

type UserDirectoryStatus string

UserDirectoryStatus - The status of the user in the directory. 

const (
	UserDirectoryStatusUnknown  UserDirectoryStatus = "UNKNOWN"
	UserDirectoryStatusEnabled  UserDirectoryStatus = "ENABLED"
	UserDirectoryStatusDisabled UserDirectoryStatus = "DISABLED"
	UserDirectoryStatusDeleted  UserDirectoryStatus = "DELETED"
)

func (UserDirectoryStatus) ToPointer ¶ added in v1.0.3 

func (e UserDirectoryStatus) ToPointer() *UserDirectoryStatus

func (*UserDirectoryStatus) UnmarshalJSON ¶ added in v1.0.3 

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

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 []map[string]interface{} `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() []map[string]interface{}

func (*UserServiceGetResponse) GetUserView ¶ added in v1.6.1 

func (o *UserServiceGetResponse) GetUserView() *UserView

type UserServiceListResponse ¶ added in v1.0.3 

type UserServiceListResponse struct {
	// List of serialized related objects.
	Expanded []map[string]interface{} `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() []map[string]interface{}

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 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

func (*UserStatus) UnmarshalJSON ¶ added in v1.0.3 

func (e *UserStatus) 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

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.