Apps

Apps

Apps

Create

client.Apps.New(ctx, body) (*AppC1APIAppV1AppAppNewResponse, error)

post/api/v1/apps

Get

client.Apps.Get(ctx, id) (*AppC1APIAppV1AppAppGetResponse, error)

get/api/v1/apps/{id}

Update

client.Apps.Update(ctx, id, body) (*AppC1APIAppV1AppAppUpdateResponse, error)

post/api/v1/apps/{id}

List

client.Apps.List(ctx, query) (*ListarrayNextPageTokenstringAppListResponse, error)

get/api/v1/apps

Delete

client.Apps.Delete(ctx, id, body) (*AppDeleteResponse, error)

delete/api/v1/apps/{id}

C1 API App V1 App

C1APIAppV1Appstruct

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

ShowShow

IDstring

optional

The ID of the app.

AppAccountIDstring

optional

The ID of the Account named by AccountName.

AppAccountNamestring

optional

The AccountName of the app. For example, AWS is AccountID, Github is Org Name, and Okta is Okta Subdomain.

AppOwnersarray

optional

[]IDstringCreatedAtTimeDelegatedUserIDstringDeletedAtTimeDepartmentstringDepartmentSourcesarrayDirectoryIDsarrayDirectoryStatusC1APIUserV1UserDirectoryStatusDirectoryStatusSourcesarrayDisplayNamestringEmailstringEmailsarrayEmailSourcesarrayEmployeeIDsarrayEmployeeIDSourcesarrayEmploymentStatusstringEmploymentStatusSourcesarrayEmploymentTypestringEmploymentTypeSourcesarrayJobTitlestringJobTitleSourcesarrayManagerIDsarrayManagerSourcesarrayProfilemapRoleIDsarrayStatusC1APIUserV1UserStatusTypeC1APIUserV1UserTypeUpdatedAtTimeUsernamestringUsernamesarrayUsernameSourcesarrayC1APIUserV1User

The owners of the app.

Hide ParametersShow Parameters

IDstring

optional

A unique identifier of the user.

CreatedAtTime

optional

formatdate-time

DelegatedUserIDstring

optional

The id of the user to whom tasks will be automatically reassigned to.

DeletedAtTime

optional

formatdate-time

Departmentstring

optional

The department which the user belongs to in the organization.

DepartmentSourcesarray

optional

[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of objects mapped based on department attribute mappings configured in the system.

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

AppUserIDstring

optional

The appUserId field.

AppUserProfileAttributeKeystring

optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring

optional

The userAttributeMappingId field.

Valuestring

optional

The value field.

DirectoryIDsarray

optional

[]string

A list of unique ids that represent different directories.

DirectoryStatusC1APIUserV1UserDirectoryStatusUnknownC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusEnabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDisabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDeletedC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatus

optional

The status of the user in the directory.

Hide ParametersShow Parameters

C1APIUserV1UserDirectoryStatusUnknownconst

C1APIUserV1UserDirectoryStatusUnknownC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusEnabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDisabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDeletedC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatus

"UNKNOWN"

C1APIUserV1UserDirectoryStatusEnabledconst

C1APIUserV1UserDirectoryStatusUnknownC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusEnabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDisabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDeletedC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatus

"ENABLED"

C1APIUserV1UserDirectoryStatusDisabledconst

C1APIUserV1UserDirectoryStatusUnknownC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusEnabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDisabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDeletedC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatus

"DISABLED"

C1APIUserV1UserDirectoryStatusDeletedconst

C1APIUserV1UserDirectoryStatusUnknownC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusEnabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDisabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDeletedC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatus

"DELETED"

DirectoryStatusSourcesarray

optional

[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of objects mapped based on directoryStatus attribute mappings configured in the system.

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

AppUserIDstring

optional

The appUserId field.

AppUserProfileAttributeKeystring

optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring

optional

The userAttributeMappingId field.

Valuestring

optional

The value field.

DisplayNamestring

optional

The display name of the user.

Emailstring

optional

This is the user's email.

Emailsarray

optional

[]string

This is a list of all of the user's emails from app users.

EmailSourcesarray

optional

[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of source data for the email attribute.

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

AppUserIDstring

optional

The appUserId field.

AppUserProfileAttributeKeystring

optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring

optional

The userAttributeMappingId field.

Valuestring

optional

The value field.

EmployeeIDsarray

optional

[]string

This is a list of all of the user's employee IDs from app users.

EmployeeIDSourcesarray

optional

[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of source data for the employee IDs attribute.

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

AppUserIDstring

optional

The appUserId field.

AppUserProfileAttributeKeystring

optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring

optional

The userAttributeMappingId field.

Valuestring

optional

The value field.

EmploymentStatusstring

optional

The users employment status.

EmploymentStatusSourcesarray

optional

[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of objects mapped based on employmentStatus attribute mappings configured in the system.

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

AppUserIDstring

optional

The appUserId field.

AppUserProfileAttributeKeystring

optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring

optional

The userAttributeMappingId field.

Valuestring

optional

The value field.

EmploymentTypestring

optional

The employment type of the user.

EmploymentTypeSourcesarray

optional

[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of objects mapped based on employmentType attribute mappings configured in the system.

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

AppUserIDstring

optional

The appUserId field.

AppUserProfileAttributeKeystring

optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring

optional

The userAttributeMappingId field.

Valuestring

optional

The value field.

JobTitlestring

optional

The job title of the user.

JobTitleSourcesarray

optional

[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of objects mapped based on jobTitle attribute mappings configured in the system.

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

AppUserIDstring

optional

The appUserId field.

AppUserProfileAttributeKeystring

optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring

optional

The userAttributeMappingId field.

Valuestring

optional

The value field.

ManagerIDsarray

optional

[]string

A list of ids of the user's managers.

ManagerSourcesarray

optional

[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of objects mapped based on managerId attribute mappings configured in the system.

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

AppUserIDstring

optional

The appUserId field.

AppUserProfileAttributeKeystring

optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring

optional

The userAttributeMappingId field.

Valuestring

optional

The value field.

Profilemap

optional

map[string, any]

RoleIDsarray

optional

[]string

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.

StatusC1APIUserV1UserStatusUnknownC1APIUserV1UserStatusC1APIUserV1UserStatusEnabledC1APIUserV1UserStatusC1APIUserV1UserStatusDisabledC1APIUserV1UserStatusC1APIUserV1UserStatusDeletedC1APIUserV1UserStatusC1APIUserV1UserStatus

optional

The status of the user in the system.

Hide ParametersShow Parameters

C1APIUserV1UserStatusUnknownconst

C1APIUserV1UserStatusUnknownC1APIUserV1UserStatusC1APIUserV1UserStatusEnabledC1APIUserV1UserStatusC1APIUserV1UserStatusDisabledC1APIUserV1UserStatusC1APIUserV1UserStatusDeletedC1APIUserV1UserStatusC1APIUserV1UserStatus

"UNKNOWN"

C1APIUserV1UserStatusEnabledconst

C1APIUserV1UserStatusUnknownC1APIUserV1UserStatusC1APIUserV1UserStatusEnabledC1APIUserV1UserStatusC1APIUserV1UserStatusDisabledC1APIUserV1UserStatusC1APIUserV1UserStatusDeletedC1APIUserV1UserStatusC1APIUserV1UserStatus

"ENABLED"

C1APIUserV1UserStatusDisabledconst

C1APIUserV1UserStatusUnknownC1APIUserV1UserStatusC1APIUserV1UserStatusEnabledC1APIUserV1UserStatusC1APIUserV1UserStatusDisabledC1APIUserV1UserStatusC1APIUserV1UserStatusDeletedC1APIUserV1UserStatusC1APIUserV1UserStatus

"DISABLED"

C1APIUserV1UserStatusDeletedconst

C1APIUserV1UserStatusUnknownC1APIUserV1UserStatusC1APIUserV1UserStatusEnabledC1APIUserV1UserStatusC1APIUserV1UserStatusDisabledC1APIUserV1UserStatusC1APIUserV1UserStatusDeletedC1APIUserV1UserStatusC1APIUserV1UserStatus

"DELETED"

TypeC1APIUserV1UserTypeUserTypeUnspecifiedC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeSystemC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeHumanC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeServiceC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeAgentC1APIUserV1UserTypeC1APIUserV1UserType

optional

The type of the user.

Hide ParametersShow Parameters

C1APIUserV1UserTypeUserTypeUnspecifiedconst

C1APIUserV1UserTypeUserTypeUnspecifiedC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeSystemC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeHumanC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeServiceC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeAgentC1APIUserV1UserTypeC1APIUserV1UserType

"USER_TYPE_UNSPECIFIED"

C1APIUserV1UserTypeUserTypeSystemconst

C1APIUserV1UserTypeUserTypeUnspecifiedC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeSystemC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeHumanC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeServiceC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeAgentC1APIUserV1UserTypeC1APIUserV1UserType

"USER_TYPE_SYSTEM"

C1APIUserV1UserTypeUserTypeHumanconst

C1APIUserV1UserTypeUserTypeUnspecifiedC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeSystemC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeHumanC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeServiceC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeAgentC1APIUserV1UserTypeC1APIUserV1UserType

"USER_TYPE_HUMAN"

C1APIUserV1UserTypeUserTypeServiceconst

C1APIUserV1UserTypeUserTypeUnspecifiedC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeSystemC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeHumanC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeServiceC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeAgentC1APIUserV1UserTypeC1APIUserV1UserType

"USER_TYPE_SERVICE"

C1APIUserV1UserTypeUserTypeAgentconst

C1APIUserV1UserTypeUserTypeUnspecifiedC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeSystemC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeHumanC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeServiceC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeAgentC1APIUserV1UserTypeC1APIUserV1UserType

"USER_TYPE_AGENT"

UpdatedAtTime

optional

formatdate-time

Usernamestring

optional

This is the user's primary username. Typically sourced from the primary directory.

Usernamesarray

optional

[]string

This is a list of all of the user's usernames from app users.

UsernameSourcesarray

optional

[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of source data for the usernames attribute.

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

AppUserIDstring

optional

The appUserId field.

AppUserProfileAttributeKeystring

optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring

optional

The userAttributeMappingId field.

Valuestring

optional

The value field.

CertifyPolicyIDstring

optional

The ID of the Certify Policy associated with this App.

ConnectorVersionint64

optional

The connectorVersion field.

formatuint32

CreatedAtTime

optional

formatdate-time

DefaultRequestCatalogIDstring

optional

The ID for the default request catalog for this app.

DeletedAtTime

optional

formatdate-time

Descriptionstring

optional

The app's description.

DisplayNamestring

optional

The app's display name.

FieldMaskstring

optional

GrantPolicyIDstring

optional

The ID of the Grant Policy associated with this App.

IconURLstring

optional

The URL of an icon to display for the app.

IdentityMatchingC1APIAppV1AppIdentityMatchingAppUserIdentityMatchingUnspecifiedC1APIAppV1AppIdentityMatchingC1APIAppV1AppIdentityMatchingAppUserIdentityMatchingStrictC1APIAppV1AppIdentityMatchingC1APIAppV1AppIdentityMatchingAppUserIdentityMatchingDisplayNameC1APIAppV1AppIdentityMatchingC1APIAppV1AppIdentityMatching

optional

The identityMatching field.

Hide ParametersShow Parameters

C1APIAppV1AppIdentityMatchingAppUserIdentityMatchingUnspecifiedconst

C1APIAppV1AppIdentityMatchingAppUserIdentityMatchingUnspecifiedC1APIAppV1AppIdentityMatchingC1APIAppV1AppIdentityMatchingAppUserIdentityMatchingStrictC1APIAppV1AppIdentityMatchingC1APIAppV1AppIdentityMatchingAppUserIdentityMatchingDisplayNameC1APIAppV1AppIdentityMatchingC1APIAppV1AppIdentityMatching

"APP_USER_IDENTITY_MATCHING_UNSPECIFIED"

C1APIAppV1AppIdentityMatchingAppUserIdentityMatchingStrictconst

C1APIAppV1AppIdentityMatchingAppUserIdentityMatchingUnspecifiedC1APIAppV1AppIdentityMatchingC1APIAppV1AppIdentityMatchingAppUserIdentityMatchingStrictC1APIAppV1AppIdentityMatchingC1APIAppV1AppIdentityMatchingAppUserIdentityMatchingDisplayNameC1APIAppV1AppIdentityMatchingC1APIAppV1AppIdentityMatching

"APP_USER_IDENTITY_MATCHING_STRICT"

C1APIAppV1AppIdentityMatchingAppUserIdentityMatchingDisplayNameconst

C1APIAppV1AppIdentityMatchingAppUserIdentityMatchingUnspecifiedC1APIAppV1AppIdentityMatchingC1APIAppV1AppIdentityMatchingAppUserIdentityMatchingStrictC1APIAppV1AppIdentityMatchingC1APIAppV1AppIdentityMatchingAppUserIdentityMatchingDisplayNameC1APIAppV1AppIdentityMatchingC1APIAppV1AppIdentityMatching

"APP_USER_IDENTITY_MATCHING_DISPLAY_NAME"

Instructionsstring

optional

If you add instructions here, they will be shown to users in the access request form when requesting access for this app.

IsDirectorybool

optional

Specifies if the app is a directory.

IsManuallyManagedbool

optional

The isManuallyManaged field.

LogoUristring

optional

The URL of a logo to display for the app.

MonthlyCostUsdint64

optional

The cost of an app per-seat, so that total cost can be calculated by the grant count.

formatint32

ParentAppIDstring

optional

The ID of the app that created this app, if any.

RevokePolicyIDstring

optional

The ID of the Revoke Policy associated with this App.

StrictAccessEntitlementProvisioningbool

optional

The strictAccessEntitlementProvisioning field.

UpdatedAtTime

optional

formatdate-time

UserCountstring

optional

The number of users with grants to this app.

formatint64

AppsAccess Request Defaults

Create App Access Requests Defaults

client.Apps.AccessRequestDefaults.New(ctx, appID, body) (*AppIDstringCatalogIDsarrayDefaultsEnabledboolDurationGrantstringDurationUnsetanyEmergencyGrantEnabledboolEmergencyGrantPolicyIDstringRequestPolicyIDstringResourceTypeIDsarrayStateC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaults, error)

post/api/v1/apps/{app_id}/access_request_defaults

Get App Access Requests Defaults

client.Apps.AccessRequestDefaults.List(ctx, appID) (*AppIDstringCatalogIDsarrayDefaultsEnabledboolDurationGrantstringDurationUnsetanyEmergencyGrantEnabledboolEmergencyGrantPolicyIDstringRequestPolicyIDstringResourceTypeIDsarrayStateC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaults, error)

get/api/v1/apps/{app_id}/access_request_defaults

Cancel App Access Requests Defaults

client.Apps.AccessRequestDefaults.Cancel(ctx, appID, body) (*AppIDstringCatalogIDsarrayDefaultsEnabledboolDurationGrantstringDurationUnsetanyEmergencyGrantEnabledboolEmergencyGrantPolicyIDstringRequestPolicyIDstringResourceTypeIDsarrayStateC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaults, error)

post/api/v1/apps/{app_id}/access_request_defaults/cancel

C1 API App V1 App Access Request Defaults

C1APIAppV1AppAccessRequestDefaultsstruct

The AppAccessRequestDefaults message.

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

• durationUnset
• durationGrant

ShowShow

AppIDstring

optional

The app id for the app access request rule

CatalogIDsarray

optional

[]string

The request catalog ids for the app access request rule.

DefaultsEnabledbool

optional

If true the app level request configuration will be applied to specified resource types.

DurationGrantstring

optional

formatduration

DurationUnsetany

optional

EmergencyGrantEnabledbool

optional

If emergency grants are enabled for this app access request rule.

EmergencyGrantPolicyIDstring

optional

The policy id for the emergency grant policy.

RequestPolicyIDstring

optional

The requestPolicyId field.

ResourceTypeIDsarray

optional

[]string

The app resource type ids for which the app access request defaults are applied.

StateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateUnspecifiedC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateRunningC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateSuccessC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateFailedC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelingC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelSuccessC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelErrorC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsState

optional

The last applied state of the app access request defaults.

Hide ParametersShow Parameters

C1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateUnspecifiedconst

C1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateUnspecifiedC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateRunningC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateSuccessC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateFailedC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelingC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelSuccessC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelErrorC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsState

"APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_UNSPECIFIED"

C1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateRunningconst

C1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateUnspecifiedC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateRunningC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateSuccessC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateFailedC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelingC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelSuccessC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelErrorC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsState

"APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_RUNNING"

C1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateSuccessconst

C1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateUnspecifiedC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateRunningC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateSuccessC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateFailedC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelingC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelSuccessC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelErrorC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsState

"APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_SUCCESS"

C1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateFailedconst

C1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateUnspecifiedC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateRunningC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateSuccessC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateFailedC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelingC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelSuccessC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelErrorC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsState

"APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_FAILED"

C1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelingconst

C1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateUnspecifiedC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateRunningC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateSuccessC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateFailedC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelingC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelSuccessC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelErrorC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsState

"APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_CANCELING"

C1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelSuccessconst

C1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateUnspecifiedC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateRunningC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateSuccessC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateFailedC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelingC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelSuccessC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelErrorC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsState

"APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_CANCEL_SUCCESS"

C1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelErrorconst

C1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateUnspecifiedC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateRunningC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateSuccessC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateFailedC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelingC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelSuccessC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsStateAppAccessRequestDefaultsLastApplyStateCancelErrorC1APIAppV1AppAccessRequestDefaultsStateC1APIAppV1AppAccessRequestDefaultsState

"APP_ACCESS_REQUEST_DEFAULTS_LAST_APPLY_STATE_CANCEL_ERROR"

AppsApp Users

Update

client.Apps.AppUsers.Update(ctx, appUserID, params) (*AppUserViewC1APIAppV1AppUserViewExpandedarrayAppAppUserUpdateResponse, error)

post/api/v1/apps/{app_user_app_id}/app_users/{app_user_id}

List

client.Apps.AppUsers.List(ctx, appID, query) (*ExpandedarrayListarrayNextPageTokenstringAppAppUserListResponse, error)

get/api/v1/apps/{app_id}/app_users

List App User Credentials

client.Apps.AppUsers.GetCredentials(ctx, appUserID, params) (*ListarrayNextPageTokenstringAppAppUserGetCredentialsResponse, error)

get/api/v1/apps/{app_id}/app_users/{app_user_id}/credentials

C1 API App V1 App User

C1APIAppV1AppUserstruct

Application User that represents an account in the application.

ShowShow

IDstring

optional

A unique idenditfier of the application user.

AppIDstring

optional

The ID of the application.

AppUserTypeC1APIAppV1AppUserAppUserTypeAppUserTypeUnspecifiedC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserTypeAppUserTypeUserC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserTypeAppUserTypeServiceAccountC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserTypeAppUserTypeSystemAccountC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserType

optional

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

Hide ParametersShow Parameters

C1APIAppV1AppUserAppUserTypeAppUserTypeUnspecifiedconst

C1APIAppV1AppUserAppUserTypeAppUserTypeUnspecifiedC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserTypeAppUserTypeUserC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserTypeAppUserTypeServiceAccountC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserTypeAppUserTypeSystemAccountC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserType

"APP_USER_TYPE_UNSPECIFIED"

C1APIAppV1AppUserAppUserTypeAppUserTypeUserconst

C1APIAppV1AppUserAppUserTypeAppUserTypeUnspecifiedC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserTypeAppUserTypeUserC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserTypeAppUserTypeServiceAccountC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserTypeAppUserTypeSystemAccountC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserType

"APP_USER_TYPE_USER"

C1APIAppV1AppUserAppUserTypeAppUserTypeServiceAccountconst

C1APIAppV1AppUserAppUserTypeAppUserTypeUnspecifiedC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserTypeAppUserTypeUserC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserTypeAppUserTypeServiceAccountC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserTypeAppUserTypeSystemAccountC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserType

"APP_USER_TYPE_SERVICE_ACCOUNT"

C1APIAppV1AppUserAppUserTypeAppUserTypeSystemAccountconst

C1APIAppV1AppUserAppUserTypeAppUserTypeUnspecifiedC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserTypeAppUserTypeUserC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserTypeAppUserTypeServiceAccountC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserTypeAppUserTypeSystemAccountC1APIAppV1AppUserAppUserTypeC1APIAppV1AppUserAppUserType

"APP_USER_TYPE_SYSTEM_ACCOUNT"

CreatedAtTime

optional

formatdate-time

DeletedAtTime

optional

formatdate-time

DisplayNamestring

optional

The display name of the application user.

Emailstring

optional

The email field of the application user.

Emailsarray

optional

[]string

The emails field of the application user.

EmployeeIDsarray

optional

[]string

The employee IDs field of the application user.

IdentityUserIDstring

optional

The conductor one user ID of the account owner.

IsExternalbool

optional

The isExternal field.

Profilemap

optional

map[string, any]

StatusDetailsstringStatusstringC1APIAppV1AppUserStatus

optional

The satus of the applicaiton user.

Hide ParametersShow Parameters

Detailsstring

optional

The details of applicaiton user status.

Statusstring

optional

The application user status field.

Hide ParametersShow Parameters

C1APIAppV1AppUserStatusStatusStatusUnspecifiedconst

C1APIAppV1AppUserStatusStatusStatusUnspecifiedC1APIAppV1AppUserStatusStatusC1APIAppV1AppUserStatusStatusStatusEnabledC1APIAppV1AppUserStatusStatusC1APIAppV1AppUserStatusStatusStatusDisabledC1APIAppV1AppUserStatusStatusC1APIAppV1AppUserStatusStatusStatusDeletedC1APIAppV1AppUserStatusStatusC1APIAppV1AppUserStatusStatus

"STATUS_UNSPECIFIED"

C1APIAppV1AppUserStatusStatusStatusEnabledconst

C1APIAppV1AppUserStatusStatusStatusUnspecifiedC1APIAppV1AppUserStatusStatusC1APIAppV1AppUserStatusStatusStatusEnabledC1APIAppV1AppUserStatusStatusC1APIAppV1AppUserStatusStatusStatusDisabledC1APIAppV1AppUserStatusStatusC1APIAppV1AppUserStatusStatusStatusDeletedC1APIAppV1AppUserStatusStatusC1APIAppV1AppUserStatusStatus

"STATUS_ENABLED"

C1APIAppV1AppUserStatusStatusStatusDisabledconst

C1APIAppV1AppUserStatusStatusStatusUnspecifiedC1APIAppV1AppUserStatusStatusC1APIAppV1AppUserStatusStatusStatusEnabledC1APIAppV1AppUserStatusStatusC1APIAppV1AppUserStatusStatusStatusDisabledC1APIAppV1AppUserStatusStatusC1APIAppV1AppUserStatusStatusStatusDeletedC1APIAppV1AppUserStatusStatusC1APIAppV1AppUserStatusStatus

"STATUS_DISABLED"

C1APIAppV1AppUserStatusStatusStatusDeletedconst

C1APIAppV1AppUserStatusStatusStatusUnspecifiedC1APIAppV1AppUserStatusStatusC1APIAppV1AppUserStatusStatusStatusEnabledC1APIAppV1AppUserStatusStatusC1APIAppV1AppUserStatusStatusStatusDisabledC1APIAppV1AppUserStatusStatusC1APIAppV1AppUserStatusStatusStatusDeletedC1APIAppV1AppUserStatusStatusC1APIAppV1AppUserStatusStatus

"STATUS_DELETED"

UpdatedAtTime

optional

formatdate-time

Usernamestring

optional

The username field of the application user.

Usernamesarray

optional

[]string

The usernames field of the application user.

C1 API App V1 App User Expand Mask

C1APIAppV1AppUserExpandMaskstruct

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

ShowShow

Pathsarray

optional

[]string

The paths to expand in the response. May be any combination of "*", "identity_user_id", "app_id", and "last_usage".

C1 API App V1 App User View

C1APIAppV1AppUserViewstruct

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

ShowShow

AppPathstring

optional

JSONPATH expression indicating where the app is expanded in expanded arrays indicated in the request.

AppUserIDstringAppIDstringAppUserTypeC1APIAppV1AppUserAppUserTypeCreatedAtTimeDeletedAtTimeDisplayNamestringEmailstringEmailsarrayEmployeeIDsarrayIdentityUserIDstringIsExternalboolProfilemapStatusC1APIAppV1AppUserStatusUpdatedAtTimeUsernamestringUsernamesarrayC1APIAppV1AppUser

optional

Application User that represents an account in the application.

IdentityUserPathstring

optional

JSONPATH expression indicating where the identity user is expanded in expanded arrays indicated in the request.

LastUsagePathstring

optional

JSONPATH expression indicating where the last usage information is expanded in expanded arrays indicated in the request.

AppsBindings

Get

client.Apps.Bindings.Get(ctx, dstAppEntitlementID, query) (*AppProxyEntitlementViewC1APIAppV1AppEntitlementProxyViewExpandedarrayAppBindingGetResponse, error)

get/api/v1/apps/{src_app_id}/{src_app_entitlement_id}/bindings/{dst_app_id}/{dst_app_entitlement_id}

Create

client.Apps.Bindings.Update(ctx, dstAppEntitlementID, params) (*AppProxyEntitlementViewC1APIAppV1AppEntitlementProxyViewExpandedarrayAppBindingUpdateResponse, error)

post/api/v1/apps/{src_app_id}/{src_app_entitlement_id}/bindings/{dst_app_id}/{dst_app_entitlement_id}

Delete

client.Apps.Bindings.Delete(ctx, dstAppEntitlementID, params) (*AppBindingDeleteResponse, error)

delete/api/v1/apps/{src_app_id}/{src_app_entitlement_id}/bindings/{dst_app_id}/{dst_app_entitlement_id}

C1 API App V1 App Entitlement Proxy View

C1APIAppV1AppEntitlementProxyViewstruct

The AppEntitlementProxyView message.

ShowShow

AppProxyEntitlementCreatedAtTimeDeletedAtTimeDstAppEntitlementIDstringDstAppIDstringImplicitboolSrcAppEntitlementIDstringSrcAppIDstringSystemBuiltinboolUpdatedAtTimeC1APIAppV1AppEntitlementProxyViewAppProxyEntitlement

optional

The AppEntitlementProxy message.

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

• implicit

Hide ParametersShow Parameters

CreatedAtTime

optional

formatdate-time

DeletedAtTime

optional

formatdate-time

DstAppEntitlementIDstring

optional

The dstAppEntitlementId field.

DstAppIDstring

optional

The dstAppId field.

Implicitbool

optional

If true, the binding doesn't not exist yet and is from the list of the entitlements from the parent app. typically the IdP that handles provisioning for the app instead of C1s connector. This field is part of the _implicit oneof. See the documentation for c1.api.app.v1.AppEntitlementProxy for more details.

SrcAppEntitlementIDstring

optional

The srcAppEntitlementId field.

SrcAppIDstring

optional

The srcAppId field.

SystemBuiltinbool

optional

The systemBuiltin field.

UpdatedAtTime

optional

formatdate-time

DstAppEntitlementPathstring

optional

The dstAppEntitlementPath field.

DstAppPathstring

optional

The dstAppPath field.

SrcAppEntitlementPathstring

optional

The srcAppEntitlementPath field.

SrcAppPathstring

optional

The srcAppPath field.

AppsConnectors

Create

client.Apps.Connectors.New(ctx, appID, body) (*ConnectorViewC1APIAppV1ConnectorViewExpandedarrayC1APIAppV1ConnectorServiceCreateResponse, error)

post/api/v1/apps/{app_id}/connectors/create

Get

client.Apps.Connectors.Get(ctx, id, query) (*ConnectorViewC1APIAppV1ConnectorViewExpandedarrayAppConnectorGetResponse, error)

get/api/v1/apps/{app_id}/connectors/{id}

Update

client.Apps.Connectors.Update(ctx, id, params) (*ConnectorViewC1APIAppV1ConnectorViewExpandedarrayC1APIAppV1ConnectorServiceUpdateResponse, error)

post/api/v1/apps/{app_id}/connectors/{id}

List

client.Apps.Connectors.List(ctx, appID, query) (*ExpandedarrayListarrayNextPageTokenstringAppConnectorListResponse, error)

get/api/v1/apps/{app_id}/connectors

Delete

client.Apps.Connectors.Delete(ctx, id, params) (*AppConnectorDeleteResponse, error)

delete/api/v1/apps/{app_id}/connectors/{id}

Create Delegated

client.Apps.Connectors.NewPending(ctx, appID, body) (*ConnectorViewC1APIAppV1ConnectorViewExpandedarrayC1APIAppV1ConnectorServiceCreateResponse, error)

post/api/v1/apps/{app_id}/connectors

Update Delegated

client.Apps.Connectors.Delegated(ctx, connectorID, params) (*ConnectorViewC1APIAppV1ConnectorViewExpandedarrayC1APIAppV1ConnectorServiceUpdateResponse, error)

post/api/v1/apps/{connector_app_id}/connectors/{connector_id}/delegated

Force Sync

client.Apps.Connectors.ForceSync(ctx, connectorID, params) (*AppConnectorForceSyncResponse, error)

post/api/v1/apps/{app_id}/connectors/{connector_id}/force_sync

C1 API App V1 Connector

C1APIAppV1Connectorstruct

A Connector is used to sync objects into Apps

ShowShow

IDstring

optional

The id of the connector.

AppIDstring

optional

The id of the app the connector is associated with.

CatalogIDstring

optional

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.

ConfigTypestringC1APIAppV1ConnectorConfig

optional

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

Hide ParametersShow Parameters

Typestring

optional

The type of the serialized message.

CreatedAtTime

optional

formatdate-time

DeletedAtTime

optional

formatdate-time

Descriptionstring

optional

The description of the connector.

DisplayNamestring

optional

The display name of the connector.

DownloadURLstring

optional

The downloadUrl for a spreadsheet if the connector was created from uploading a file.

OAuthAuthorizedAsAuthEmailstringAuthorizedAtTimeC1APIAppV1OAuth2AuthorizedAs

optional

OAuth2AuthorizedAs tracks the user that OAuthed with the connector.

ProfileAllowListarray

optional

[]string

List of profile attributes to sync, when set only these attributes will be synced

ProfileIgnoreListarray

optional

[]string

List of profile attributes to ignore (not sync), when set other attributes will be synced, but these will not.

StatusCompletedAtTimeLastErrorstringStartedAtTimeStatusC1APIAppV1ConnectorStatusStatusUpdatedAtTimeC1APIAppV1ConnectorStatus

optional

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.

SyncDisabledAtTime

optional

formatdate-time

SyncDisabledCategorystring

optional

The category of the connector sync that was disabled.

SyncDisabledReasonstring

optional

The reason the connector sync was disabled.

UpdatedAtTime

optional

formatdate-time

UserIDsarray

optional

[]string

The userIds field is used to define the integration owners of the connector.

C1 API App V1 Connector Expand Mask

C1APIAppV1ConnectorExpandMaskstruct

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

ShowShow

Pathsarray

optional

[]string

Paths that you want expanded in the response. Possible values are "app_id" and "*".

C1 API App V1 Connector Service Create Response

C1APIAppV1ConnectorServiceCreateResponsestruct

The ConnectorServiceCreateResponse is the response returned from creating a connector.

ShowShow

ConnectorViewAppPathstringConnectorC1APIAppV1ConnectorUsersPathstringC1APIAppV1ConnectorView

optional

The ConnectorView object provides a connector response object, as well as JSONPATHs to related objects provided by expanders.

Expandedarray

optional

[]C1APIAppV1ConnectorServiceCreateResponseExpanded

The array of expanded items indicated by the request.

Hide ParametersShow Parameters

Typestring

optional

The type of the serialized message.

C1 API App V1 Connector Service Update Response

C1APIAppV1ConnectorServiceUpdateResponsestruct

ConnectorServiceUpdateResponse is the response returned by the update method.

ShowShow

ConnectorViewAppPathstringConnectorC1APIAppV1ConnectorUsersPathstringC1APIAppV1ConnectorView

optional

The ConnectorView object provides a connector response object, as well as JSONPATHs to related objects provided by expanders.

Expandedarray

optional

[]C1APIAppV1ConnectorServiceUpdateResponseExpanded

The array of expanded items indicated by the request.

Hide ParametersShow Parameters

Typestring

optional

The type of the serialized message.

C1 API App V1 Connector Status

C1APIAppV1ConnectorStatusstruct

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.

ShowShow

CompletedAtTime

optional

formatdate-time

LastErrorstring

optional

The last error encountered by the connector.

StartedAtTime

optional

formatdate-time

StatusC1APIAppV1ConnectorStatusStatusSyncStatusUnspecifiedC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusRunningC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusDoneC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusErrorC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusDisabledC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatus

optional

The status of the connector sync.

Hide ParametersShow Parameters

C1APIAppV1ConnectorStatusStatusSyncStatusUnspecifiedconst

C1APIAppV1ConnectorStatusStatusSyncStatusUnspecifiedC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusRunningC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusDoneC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusErrorC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusDisabledC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatus

"SYNC_STATUS_UNSPECIFIED"

C1APIAppV1ConnectorStatusStatusSyncStatusRunningconst

C1APIAppV1ConnectorStatusStatusSyncStatusUnspecifiedC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusRunningC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusDoneC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusErrorC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusDisabledC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatus

"SYNC_STATUS_RUNNING"

C1APIAppV1ConnectorStatusStatusSyncStatusDoneconst

C1APIAppV1ConnectorStatusStatusSyncStatusUnspecifiedC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusRunningC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusDoneC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusErrorC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusDisabledC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatus

"SYNC_STATUS_DONE"

C1APIAppV1ConnectorStatusStatusSyncStatusErrorconst

C1APIAppV1ConnectorStatusStatusSyncStatusUnspecifiedC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusRunningC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusDoneC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusErrorC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusDisabledC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatus

"SYNC_STATUS_ERROR"

C1APIAppV1ConnectorStatusStatusSyncStatusDisabledconst

C1APIAppV1ConnectorStatusStatusSyncStatusUnspecifiedC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusRunningC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusDoneC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusErrorC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatusSyncStatusDisabledC1APIAppV1ConnectorStatusStatusC1APIAppV1ConnectorStatusStatus

"SYNC_STATUS_DISABLED"

UpdatedAtTime

optional

formatdate-time

C1 API App V1 Connector View

C1APIAppV1ConnectorViewstruct

The ConnectorView object provides a connector response object, as well as JSONPATHs to related objects provided by expanders.

ShowShow

AppPathstring

optional

JSONPATH expression indicating the location of the App object in the expanded array.

ConnectorIDstringAppIDstringCatalogIDstringConfigC1APIAppV1ConnectorConfigCreatedAtTimeDeletedAtTimeDescriptionstringDisplayNamestringDownloadURLstringOAuthAuthorizedAsC1APIAppV1OAuth2AuthorizedAsProfileAllowListarrayProfileIgnoreListarrayStatusC1APIAppV1ConnectorStatusSyncDisabledAtTimeSyncDisabledCategorystringSyncDisabledReasonstringUpdatedAtTimeUserIDsarrayC1APIAppV1Connector

optional

A Connector is used to sync objects into Apps

UsersPathstring

optional

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.

C1 API App V1 O Auth2 Authorized As

C1APIAppV1OAuth2AuthorizedAsstruct

OAuth2AuthorizedAs tracks the user that OAuthed with the connector.

ShowShow

AuthEmailstring

optional

authEmail is the email of the user that authorized the connector using OAuth.

AuthorizedAtTime

optional

formatdate-time

AppsConnectorsCredentials

Rotate Credential

client.Apps.Connectors.Credentials.New(ctx, connectorID, params) (*ClientSecretstringCredentialC1APIAppV1ConnectorCredentialAppConnectorCredentialNewResponse, error)

post/api/v1/apps/{app_id}/connectors/{connector_id}/credentials

Get Credentials

client.Apps.Connectors.Credentials.Get(ctx, id, query) (*CredentialC1APIAppV1ConnectorCredentialAppConnectorCredentialGetResponse, error)

get/api/v1/apps/{app_id}/connectors/{connector_id}/credentials/{id}

Revoke Credential

client.Apps.Connectors.Credentials.Update(ctx, id, params) (*AppConnectorCredentialUpdateResponse, error)

post/api/v1/apps/{app_id}/connectors/{connector_id}/credentials/{id}

C1 API App V1 Connector Credential

C1APIAppV1ConnectorCredentialstruct

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

ShowShow

IDstring

optional

The id of the ConnectorCredential.

AppIDstring

optional

The appId of the app the connector is attached to.

ClientIDstring

optional

The client id of the ConnectorCredential.

ConnectorIDstring

optional

The connectorId of the connector the credential is associated with.

CreatedAtTime

optional

formatdate-time

DeletedAtTime

optional

formatdate-time

DisplayNamestring

optional

The display name of the ConnectorCredential.

ExpiresTimeTime

optional

formatdate-time

LastUsedAtTime

optional

formatdate-time

UpdatedAtTime

optional

formatdate-time

AppsConnectorsValidate Config

Validate Http Connector Config

client.Apps.Connectors.ValidateConfig.HTTP(ctx, body) (*MarkersarrayAppConnectorValidateConfigHTTPResponse, error)

post/api/v1/apps/connectors/validate_config/http

C1 API Editor V1 Editor Marker

C1APIEditorV1EditorMarkerstruct

The EditorMarker message.

ShowShow

EndColumnint64

optional

The endColumn field.

formatint32

EndLineNumberint64

optional

The endLineNumber field.

formatint32

Messagestring

optional

The message field.

SeverityC1APIEditorV1EditorMarkerSeverityUnknownC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityHintC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityInfoC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityWarningC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityErrorC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverity

optional

The severity field.

Hide ParametersShow Parameters

C1APIEditorV1EditorMarkerSeverityUnknownconst

C1APIEditorV1EditorMarkerSeverityUnknownC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityHintC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityInfoC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityWarningC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityErrorC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverity

"UNKNOWN"

C1APIEditorV1EditorMarkerSeverityHintconst

C1APIEditorV1EditorMarkerSeverityUnknownC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityHintC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityInfoC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityWarningC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityErrorC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverity

"HINT"

C1APIEditorV1EditorMarkerSeverityInfoconst

C1APIEditorV1EditorMarkerSeverityUnknownC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityHintC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityInfoC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityWarningC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityErrorC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverity

"INFO"

C1APIEditorV1EditorMarkerSeverityWarningconst

C1APIEditorV1EditorMarkerSeverityUnknownC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityHintC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityInfoC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityWarningC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityErrorC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverity

"WARNING"

C1APIEditorV1EditorMarkerSeverityErrorconst

C1APIEditorV1EditorMarkerSeverityUnknownC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityHintC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityInfoC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityWarningC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverityErrorC1APIEditorV1EditorMarkerSeverityC1APIEditorV1EditorMarkerSeverity

"ERROR"

StartColumnint64

optional

The startColumn field.

formatint32

StartLineNumberint64

optional

The startLineNumber field.

formatint32

AppsEntitlements

Create

client.Apps.Entitlements.New(ctx, appID, body) (*AppEntitlementViewC1APIAppV1AppEntitlementViewExpandedarrayAppEntitlementNewResponse, error)

post/api/v1/apps/{app_id}/entitlements

Get

client.Apps.Entitlements.Get(ctx, id, query) (*AppEntitlementViewC1APIAppV1AppEntitlementViewExpandedarrayAppEntitlementGetResponse, error)

get/api/v1/apps/{app_id}/entitlements/{id}

Update

client.Apps.Entitlements.Update(ctx, id, params) (*AppEntitlementViewC1APIAppV1AppEntitlementViewExpandedarrayAppEntitlementUpdateResponse, error)

post/api/v1/apps/{app_id}/entitlements/{id}

List

client.Apps.Entitlements.List(ctx, appID, query) (*ExpandedarrayListarrayNextPageTokenstringC1APIAppV1ListAppEntitlementsResponse, error)

get/api/v1/apps/{app_id}/entitlements

Delete

client.Apps.Entitlements.Delete(ctx, id, params) (*AppEntitlementDeleteResponse, error)

delete/api/v1/apps/{app_id}/entitlements/{id}

Add Manually Managed Members

client.Apps.Entitlements.AddManualUser(ctx, appEntitlementID, params) (*FailedUsersErrorMapmapAppEntitlementAddManualUserResponse, error)

post/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/add-manual-user

Remove Entitlement Membership

client.Apps.Entitlements.DeleteRemoveMembership(ctx, appEntitlementID, params) (*RevokeTaskIDstringAppEntitlementDeleteRemoveMembershipResponse, error)

delete/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/remove-membership

Search App Entitlements With Expired

client.Apps.Entitlements.GetGrants(ctx, appEntitlementID, params) (*ListarrayNextPageTokenstringAppEntitlementGetGrantsResponse, error)

get/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/grants

C1 API App V1 App Entitlement

C1APIAppV1AppEntitlementstruct

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

ShowShow

IDstring

optional

The unique ID for the App Entitlement.

Aliasstring

optional

The alias of the app entitlement used by Cone. Also exact-match queryable.

AppIDstring

optional

The ID of the app that is associated with the app entitlement.

AppResourceIDstring

optional

The ID of the app resource that is associated with the app entitlement

AppResourceTypeIDstring

optional

The ID of the app resource type that is associated with the app entitlement

CertifyPolicyIDstring

optional

The ID of the policy that will be used for certify tickets related to the app entitlement.

ComplianceFrameworkValueIDsarray

optional

[]string

The IDs of different compliance frameworks associated with this app entitlement ex (SOX, HIPAA, PCI, etc.)

CreatedAtTime

optional

formatdate-time

DefaultValuesAppliedbool

optional

Flag to indicate if app-level access request defaults have been applied to the entitlement

DeletedAtTime

optional

formatdate-time

DeprovisionerPolicyConnectorC1APIPolicyV1ProvisionPolicyConnectorDelegatedC1APIPolicyV1ProvisionPolicyDelegatedExternalTicketC1APIPolicyV1ProvisionPolicyExternalTicketManualC1APIPolicyV1ProvisionPolicyManualUnconfiguredanyWebhookC1APIPolicyV1ProvisionPolicyWebhookC1APIPolicyV1ProvisionPolicy

optional

ProvisionPolicy is a oneOf that indicates how a provision step should be processed.

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

• connector
• manual
• delegated
• webhook
• multiStep
• externalTicket
• unconfigured

Descriptionstring

optional

The description of the app entitlement.

DisplayNamestring

optional

The display name of the app entitlement.

DurationGrantstring

optional

formatduration

DurationUnsetany

optional

EmergencyGrantEnabledbool

optional

This enables tasks to be created in an emergency and use a selected emergency access policy.

EmergencyGrantPolicyIDstring

optional

The ID of the policy that will be used for emergency access grant tasks.

GrantCountstring

optional

The amount of grants open for this entitlement

formatint64

GrantPolicyIDstring

optional

The ID of the policy that will be used for grant tickets related to the app entitlement.

IsAutomationEnabledbool

optional

Flag to indicate whether automation (for adding users to entitlement based on rules) has been enabled.

IsManuallyManagedbool

optional

Flag to indicate if the app entitlement is manually managed.

MatchBatonIDstring

optional

The matchBatonId field.

OverrideAccessRequestsDefaultsbool

optional

Flag to indicate if the app-level access request settings have been overridden for the entitlement

ProvisionerPolicyConnectorC1APIPolicyV1ProvisionPolicyConnectorDelegatedC1APIPolicyV1ProvisionPolicyDelegatedExternalTicketC1APIPolicyV1ProvisionPolicyExternalTicketManualC1APIPolicyV1ProvisionPolicyManualUnconfiguredanyWebhookC1APIPolicyV1ProvisionPolicyWebhookC1APIPolicyV1ProvisionPolicy

optional

ProvisionPolicy is a oneOf that indicates how a provision step should be processed.

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

• connector
• manual
• delegated
• webhook
• multiStep
• externalTicket
• unconfigured

PurposeC1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueUnspecifiedC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueAssignmentC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValuePermissionC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurpose

optional

The purpose field.

Hide ParametersShow Parameters

C1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueUnspecifiedconst

C1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueUnspecifiedC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueAssignmentC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValuePermissionC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurpose

"APP_ENTITLEMENT_PURPOSE_VALUE_UNSPECIFIED"

C1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueAssignmentconst

C1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueUnspecifiedC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueAssignmentC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValuePermissionC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurpose

"APP_ENTITLEMENT_PURPOSE_VALUE_ASSIGNMENT"

C1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValuePermissionconst

C1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueUnspecifiedC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValueAssignmentC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurposeAppEntitlementPurposeValuePermissionC1APIAppV1AppEntitlementPurposeC1APIAppV1AppEntitlementPurpose

"APP_ENTITLEMENT_PURPOSE_VALUE_PERMISSION"

RevokePolicyIDstring

optional

The ID of the policy that will be used for revoke tickets related to the app entitlement

RiskLevelValueIDstring

optional

The riskLevelValueId field.

Slugstring

optional

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

SourceConnectorIDsmap

optional

map[string, string]

Map to tell us which connector the entitlement came from.

SystemBuiltinbool

optional

This field indicates if this is a system builtin entitlement.

UpdatedAtTime

optional

formatdate-time

UserEditedMaskstring

optional

C1 API App V1 App Entitlement Expand Mask

C1APIAppV1AppEntitlementExpandMaskstruct

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

ShowShow

Pathsarray

optional

[]string

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

C1 API App V1 App Entitlement View

C1APIAppV1AppEntitlementViewstruct

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

ShowShow

AppEntitlementIDstringAliasstringAppIDstringAppResourceIDstringAppResourceTypeIDstringCertifyPolicyIDstringComplianceFrameworkValueIDsarrayCreatedAtTimeDefaultValuesAppliedboolDeletedAtTimeDeprovisionerPolicyC1APIPolicyV1ProvisionPolicyDescriptionstringDisplayNamestringDurationGrantstringDurationUnsetanyEmergencyGrantEnabledboolEmergencyGrantPolicyIDstringGrantCountstringGrantPolicyIDstringIsAutomationEnabledboolIsManuallyManagedboolMatchBatonIDstringOverrideAccessRequestsDefaultsboolProvisionerPolicyC1APIPolicyV1ProvisionPolicyPurposeC1APIAppV1AppEntitlementPurposeRevokePolicyIDstringRiskLevelValueIDstringSlugstringSourceConnectorIDsmapSystemBuiltinboolUpdatedAtTimeUserEditedMaskstringC1APIAppV1AppEntitlement

optional

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

AppPathstring

optional

JSONPATH expression indicating the location of the App object in the array.

AppResourcePathstring

optional

JSONPATH expression indicating the location of the App Resource Type object in the expanded array.

AppResourceTypePathstring

optional

JSONPATH expression indicating the location of the App Resource object in the array.

C1 API App V1 List App Entitlements Response

C1APIAppV1ListAppEntitlementsResponsestruct

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

ShowShow

Expandedarray

optional

[]C1APIAppV1ListAppEntitlementsResponseExpanded

List of related objects

Hide ParametersShow Parameters

Typestring

optional

The type of the serialized message.

Listarray

optional

[]AppEntitlementC1APIAppV1AppEntitlementAppPathstringAppResourcePathstringAppResourceTypePathstringC1APIAppV1AppEntitlementView

The list of results containing up to X results, where X is the page size defined in the request.

Hide ParametersShow Parameters

AppEntitlementIDstringAliasstringAppIDstringAppResourceIDstringAppResourceTypeIDstringCertifyPolicyIDstringComplianceFrameworkValueIDsarrayCreatedAtTimeDefaultValuesAppliedboolDeletedAtTimeDeprovisionerPolicyC1APIPolicyV1ProvisionPolicyDescriptionstringDisplayNamestringDurationGrantstringDurationUnsetanyEmergencyGrantEnabledboolEmergencyGrantPolicyIDstringGrantCountstringGrantPolicyIDstringIsAutomationEnabledboolIsManuallyManagedboolMatchBatonIDstringOverrideAccessRequestsDefaultsboolProvisionerPolicyC1APIPolicyV1ProvisionPolicyPurposeC1APIAppV1AppEntitlementPurposeRevokePolicyIDstringRiskLevelValueIDstringSlugstringSourceConnectorIDsmapSystemBuiltinboolUpdatedAtTimeUserEditedMaskstringC1APIAppV1AppEntitlement

optional

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

AppPathstring

optional

JSONPATH expression indicating the location of the App object in the array.

AppResourcePathstring

optional

JSONPATH expression indicating the location of the App Resource Type object in the expanded array.

AppResourceTypePathstring

optional

JSONPATH expression indicating the location of the App Resource object in the array.

NextPageTokenstring

optional

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.

C1 API Policy V1 Multi Step

C1APIPolicyV1MultiStepstruct

MultiStep indicates that this provision step has multiple steps to process.

ShowShow

ProvisionStepsarray

optional

[]ConnectorC1APIPolicyV1ProvisionPolicyConnectorDelegatedC1APIPolicyV1ProvisionPolicyDelegatedExternalTicketC1APIPolicyV1ProvisionPolicyExternalTicketManualC1APIPolicyV1ProvisionPolicyManualUnconfiguredanyWebhookC1APIPolicyV1ProvisionPolicyWebhookC1APIPolicyV1ProvisionPolicy

The array of provision steps to process.

Hide ParametersShow Parameters

ConnectorAccountC1APIPolicyV1ProvisionPolicyConnectorAccountDefaultBehaviorC1APIPolicyV1ProvisionPolicyConnectorDefaultBehaviorDeleteAccountC1APIPolicyV1ProvisionPolicyConnectorDeleteAccountC1APIPolicyV1ProvisionPolicyConnector

optional

Indicates that a connector should perform the provisioning. This object has no fields.

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

• defaultBehavior
• account
• deleteAccount

Hide ParametersShow Parameters

AccountConfigmapConnectorIDstringDoNotSaveanySaveToVaultC1APIPolicyV1ProvisionPolicyConnectorAccountSaveToVaultSchemaIDstringC1APIPolicyV1ProvisionPolicyConnectorAccount

optional

The AccountProvision message.

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

• saveToVault
• doNotSave

Hide ParametersShow Parameters

Configmap

optional

map[string, any]

ConnectorIDstring

optional

The connectorId field.

DoNotSaveany

optional

The DoNotSave message.

SaveToVaultVaultIDsarrayC1APIPolicyV1ProvisionPolicyConnectorAccountSaveToVault

optional

The SaveToVault message.

Hide ParametersShow Parameters

VaultIDsarray

optional

[]string

The vaultIds field.

SchemaIDstring

optional

The schemaId field.

DefaultBehaviorConnectorIDstringC1APIPolicyV1ProvisionPolicyConnectorDefaultBehavior

optional

The DefaultBehavior message.

Hide ParametersShow Parameters

ConnectorIDstring

optional

this checks if the entitlement is enabled by provisioning in a specific connector this can happen automatically and doesn't need any extra info

DeleteAccountConnectorIDstringC1APIPolicyV1ProvisionPolicyConnectorDeleteAccount

optional

The DeleteAccount message.

Hide ParametersShow Parameters

ConnectorIDstring

optional

The connectorId field.

DelegatedAppIDstringEntitlementIDstringImplicitboolC1APIPolicyV1ProvisionPolicyDelegated

optional

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.

Hide ParametersShow Parameters

AppIDstring

optional

The AppID of the entitlement to delegate provisioning to.

EntitlementIDstring

optional

The ID of the entitlement we are delegating provisioning to.

Implicitbool

optional

If true, a binding will be automatically created from the entitlement of the parent app.

ExternalTicketAppIDstringConnectorIDstringExternalTicketProvisionerConfigIDstringInstructionsstringC1APIPolicyV1ProvisionPolicyExternalTicket

optional

This provision step indicates that we should check an external ticket to provision this entitlement

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

ConnectorIDstring

optional

The connectorId field.

ExternalTicketProvisionerConfigIDstring

optional

The externalTicketProvisionerConfigId field.

Instructionsstring

optional

This field indicates a text body of instructions for the provisioner to indicate.

ManualInstructionsstringUserIDsarrayC1APIPolicyV1ProvisionPolicyManual

optional

Manual provisioning indicates that a human must intervene for the provisioning of this step.

Hide ParametersShow Parameters

Instructionsstring

optional

This field indicates a text body of instructions for the provisioner to indicate.

UserIDsarray

optional

[]string

An array of users that are required to provision during this step.

Unconfiguredany

optional

The UnconfiguredProvision message.

WebhookWebhookIDstringC1APIPolicyV1ProvisionPolicyWebhook

optional

This provision step indicates that a webhook should be called to provision this entitlement.

Hide ParametersShow Parameters

WebhookIDstring

optional

The ID of the webhook to call for provisioning.

C1 API Policy V1 Provision Policy

C1APIPolicyV1ProvisionPolicystruct

ProvisionPolicy is a oneOf that indicates how a provision step should be processed.

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

• connector
• manual
• delegated
• webhook
• multiStep
• externalTicket
• unconfigured

ShowShow

ConnectorAccountC1APIPolicyV1ProvisionPolicyConnectorAccountDefaultBehaviorC1APIPolicyV1ProvisionPolicyConnectorDefaultBehaviorDeleteAccountC1APIPolicyV1ProvisionPolicyConnectorDeleteAccountC1APIPolicyV1ProvisionPolicyConnector

optional

Indicates that a connector should perform the provisioning. This object has no fields.

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

• defaultBehavior
• account
• deleteAccount

Hide ParametersShow Parameters

AccountConfigmapConnectorIDstringDoNotSaveanySaveToVaultC1APIPolicyV1ProvisionPolicyConnectorAccountSaveToVaultSchemaIDstringC1APIPolicyV1ProvisionPolicyConnectorAccount

optional

The AccountProvision message.

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

• saveToVault
• doNotSave

Hide ParametersShow Parameters

Configmap

optional

map[string, any]

ConnectorIDstring

optional

The connectorId field.

DoNotSaveany

optional

The DoNotSave message.

SaveToVaultVaultIDsarrayC1APIPolicyV1ProvisionPolicyConnectorAccountSaveToVault

optional

The SaveToVault message.

Hide ParametersShow Parameters

VaultIDsarray

optional

[]string

The vaultIds field.

SchemaIDstring

optional

The schemaId field.

DefaultBehaviorConnectorIDstringC1APIPolicyV1ProvisionPolicyConnectorDefaultBehavior

optional

The DefaultBehavior message.

Hide ParametersShow Parameters

ConnectorIDstring

optional

this checks if the entitlement is enabled by provisioning in a specific connector this can happen automatically and doesn't need any extra info

DeleteAccountConnectorIDstringC1APIPolicyV1ProvisionPolicyConnectorDeleteAccount

optional

The DeleteAccount message.

Hide ParametersShow Parameters

ConnectorIDstring

optional

The connectorId field.

DelegatedAppIDstringEntitlementIDstringImplicitboolC1APIPolicyV1ProvisionPolicyDelegated

optional

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.

Hide ParametersShow Parameters

AppIDstring

optional

The AppID of the entitlement to delegate provisioning to.

EntitlementIDstring

optional

The ID of the entitlement we are delegating provisioning to.

Implicitbool

optional

If true, a binding will be automatically created from the entitlement of the parent app.

ExternalTicketAppIDstringConnectorIDstringExternalTicketProvisionerConfigIDstringInstructionsstringC1APIPolicyV1ProvisionPolicyExternalTicket

optional

This provision step indicates that we should check an external ticket to provision this entitlement

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

ConnectorIDstring

optional

The connectorId field.

ExternalTicketProvisionerConfigIDstring

optional

The externalTicketProvisionerConfigId field.

Instructionsstring

optional

This field indicates a text body of instructions for the provisioner to indicate.

ManualInstructionsstringUserIDsarrayC1APIPolicyV1ProvisionPolicyManual

optional

Manual provisioning indicates that a human must intervene for the provisioning of this step.

Hide ParametersShow Parameters

Instructionsstring

optional

This field indicates a text body of instructions for the provisioner to indicate.

UserIDsarray

optional

[]string

An array of users that are required to provision during this step.

Unconfiguredany

optional

The UnconfiguredProvision message.

WebhookWebhookIDstringC1APIPolicyV1ProvisionPolicyWebhook

optional

This provision step indicates that a webhook should be called to provision this entitlement.

Hide ParametersShow Parameters

WebhookIDstring

optional

The ID of the webhook to call for provisioning.

AppsEntitlementsAutomation

Create Automation

client.Apps.Entitlements.Automation.New(ctx, appEntitlementID, params) (*AutomationC1APIAppV1AppEntitlementAutomationAppEntitlementAutomationNewResponse, error)

post/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/automation/create

Update Automation

client.Apps.Entitlements.Automation.Update(ctx, appEntitlementID, params) (*AppEntitlementAutomationC1APIAppV1AppEntitlementAutomationAppEntitlementAutomationUpdateResponse, error)

post/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/automation/update

Get Automation

client.Apps.Entitlements.Automation.List(ctx, appEntitlementID, query) (*AppEntitlementAutomationC1APIAppV1AppEntitlementAutomationAppEntitlementAutomationListResponse, error)

get/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/automation

Delete Automation

client.Apps.Entitlements.Automation.DeleteAll(ctx, appEntitlementID, params) (*AppEntitlementAutomationDeleteAllResponse, error)

delete/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/automation

C1 API App V1 App Entitlement Automation

C1APIAppV1AppEntitlementAutomationstruct

The AppEntitlementAutomation message.

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

• none
• entitlements
• cel
• basic

ShowShow

AppEntitlementIDstring

optional

The unique ID for the App Entitlement.

AppIDstring

optional

The ID of the app that is associated with the app entitlement.

BasicExpressionstringC1APIAppV1AppEntitlementAutomationRuleBasic

optional

The AppEntitlementAutomationRuleBasic message.

CelExpressionstringC1APIAppV1AppEntitlementAutomationRuleCel

optional

The AppEntitlementAutomationRuleCEL message.

CreatedAtTime

optional

formatdate-time

DeletedAtTime

optional

formatdate-time

Descriptionstring

optional

The description of the app entitlement.

DisplayNamestring

optional

The display name of the app entitlement.

EntitlementsEntitlementRefsarrayC1APIAppV1AppEntitlementAutomationRuleEntitlement

optional

The AppEntitlementAutomationRuleEntitlement message.

LastRunStatusErrorMessagestringLastCompletedAtTimeStatusstringC1APIAppV1AppEntitlementAutomationLastRunStatus

optional

The AppEntitlementAutomationLastRunStatus message.

Hide ParametersShow Parameters

ErrorMessagestring

optional

The errorMessage field.

LastCompletedAtTime

optional

formatdate-time

Statusstring

optional

The status field.

Hide ParametersShow Parameters

C1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusUnspecifiedconst

C1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusUnspecifiedC1APIAppV1AppEntitlementAutomationLastRunStatusStatusC1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusSuccessC1APIAppV1AppEntitlementAutomationLastRunStatusStatusC1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusFailedC1APIAppV1AppEntitlementAutomationLastRunStatusStatusC1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusInProgressC1APIAppV1AppEntitlementAutomationLastRunStatusStatusC1APIAppV1AppEntitlementAutomationLastRunStatusStatus

"APP_ENTITLEMENT_AUTOMATION_RUN_STATUS_UNSPECIFIED"

C1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusSuccessconst

C1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusUnspecifiedC1APIAppV1AppEntitlementAutomationLastRunStatusStatusC1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusSuccessC1APIAppV1AppEntitlementAutomationLastRunStatusStatusC1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusFailedC1APIAppV1AppEntitlementAutomationLastRunStatusStatusC1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusInProgressC1APIAppV1AppEntitlementAutomationLastRunStatusStatusC1APIAppV1AppEntitlementAutomationLastRunStatusStatus

"APP_ENTITLEMENT_AUTOMATION_RUN_STATUS_SUCCESS"

C1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusFailedconst

C1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusUnspecifiedC1APIAppV1AppEntitlementAutomationLastRunStatusStatusC1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusSuccessC1APIAppV1AppEntitlementAutomationLastRunStatusStatusC1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusFailedC1APIAppV1AppEntitlementAutomationLastRunStatusStatusC1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusInProgressC1APIAppV1AppEntitlementAutomationLastRunStatusStatusC1APIAppV1AppEntitlementAutomationLastRunStatusStatus

"APP_ENTITLEMENT_AUTOMATION_RUN_STATUS_FAILED"

C1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusInProgressconst

C1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusUnspecifiedC1APIAppV1AppEntitlementAutomationLastRunStatusStatusC1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusSuccessC1APIAppV1AppEntitlementAutomationLastRunStatusStatusC1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusFailedC1APIAppV1AppEntitlementAutomationLastRunStatusStatusC1APIAppV1AppEntitlementAutomationLastRunStatusStatusAppEntitlementAutomationRunStatusInProgressC1APIAppV1AppEntitlementAutomationLastRunStatusStatusC1APIAppV1AppEntitlementAutomationLastRunStatusStatus

"APP_ENTITLEMENT_AUTOMATION_RUN_STATUS_IN_PROGRESS"

Noneany

optional

The AppEntitlementAutomationRuleNone message.

UpdatedAtTime

optional

formatdate-time

C1 API App V1 App Entitlement Automation Rule Basic

C1APIAppV1AppEntitlementAutomationRuleBasicstruct

The AppEntitlementAutomationRuleBasic message.

ShowShow

Expressionstring

optional

The expression field.

C1 API App V1 App Entitlement Automation Rule Cel

C1APIAppV1AppEntitlementAutomationRuleCelstruct

The AppEntitlementAutomationRuleCEL message.

ShowShow

Expressionstring

optional

The expression field.

C1 API App V1 App Entitlement Automation Rule Entitlement

C1APIAppV1AppEntitlementAutomationRuleEntitlementstruct

The AppEntitlementAutomationRuleEntitlement message.

ShowShow

EntitlementRefsarray

optional

[]IDstringAppIDstringAppEntitlementRef

The entitlementRefs field.

Hide ParametersShow Parameters

IDstring

optional

The id field.

AppIDstring

optional

The appId field.

AppsEntitlementsAutomationExclusions

Add Automation Exclusion

client.Apps.Entitlements.Automation.Exclusions.New(ctx, appEntitlementID, params) (*AppEntitlementAutomationExclusionNewResponse, error)

post/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/automation/exclusions

List Automation Exclusions

client.Apps.Entitlements.Automation.Exclusions.List(ctx, appEntitlementID, query) (*ListarrayNextPageTokenstringAppEntitlementAutomationExclusionListResponse, error)

get/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/automation/exclusions

Remove Automation Exclusion

client.Apps.Entitlements.Automation.Exclusions.DeleteAll(ctx, appEntitlementID, params) (*AppEntitlementAutomationExclusionDeleteAllResponse, error)

delete/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/automation/exclusions

AppsEntitlementsOwners

Set

client.Apps.Entitlements.Owners.Update(ctx, entitlementID, params) (*AppEntitlementOwnerUpdateResponse, error)

put/api/v1/apps/{app_id}/entitlements/{entitlement_id}/owners

List

client.Apps.Entitlements.Owners.List(ctx, entitlementID, params) (*ListarrayNextPageTokenstringAppEntitlementOwnerListResponse, error)

get/api/v1/apps/{app_id}/entitlements/{entitlement_id}/owners

Remove

client.Apps.Entitlements.Owners.Delete(ctx, userID, params) (*AppEntitlementOwnerDeleteResponse, error)

delete/api/v1/apps/{app_id}/entitlements/{entitlement_id}/owners/{user_id}

Add

client.Apps.Entitlements.Owners.Add(ctx, entitlementID, params) (*AppEntitlementOwnerAddResponse, error)

post/api/v1/apps/{app_id}/entitlements/{entitlement_id}/owners

C1 API User V1 User

C1APIUserV1Userstruct

The User object provides all of the details for an user, as well as some configuration.

ShowShow

IDstring

optional

A unique identifier of the user.

CreatedAtTime

optional

formatdate-time

DelegatedUserIDstring

optional

The id of the user to whom tasks will be automatically reassigned to.

DeletedAtTime

optional

formatdate-time

Departmentstring

optional

The department which the user belongs to in the organization.

DepartmentSourcesarray

optional

[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of objects mapped based on department attribute mappings configured in the system.

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

AppUserIDstring

optional

The appUserId field.

AppUserProfileAttributeKeystring

optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring

optional

The userAttributeMappingId field.

Valuestring

optional

The value field.

DirectoryIDsarray

optional

[]string

A list of unique ids that represent different directories.

DirectoryStatusC1APIUserV1UserDirectoryStatusUnknownC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusEnabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDisabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDeletedC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatus

optional

The status of the user in the directory.

Hide ParametersShow Parameters

C1APIUserV1UserDirectoryStatusUnknownconst

C1APIUserV1UserDirectoryStatusUnknownC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusEnabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDisabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDeletedC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatus

"UNKNOWN"

C1APIUserV1UserDirectoryStatusEnabledconst

C1APIUserV1UserDirectoryStatusUnknownC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusEnabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDisabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDeletedC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatus

"ENABLED"

C1APIUserV1UserDirectoryStatusDisabledconst

C1APIUserV1UserDirectoryStatusUnknownC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusEnabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDisabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDeletedC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatus

"DISABLED"

C1APIUserV1UserDirectoryStatusDeletedconst

C1APIUserV1UserDirectoryStatusUnknownC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusEnabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDisabledC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatusDeletedC1APIUserV1UserDirectoryStatusC1APIUserV1UserDirectoryStatus

"DELETED"

DirectoryStatusSourcesarray

optional

[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of objects mapped based on directoryStatus attribute mappings configured in the system.

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

AppUserIDstring

optional

The appUserId field.

AppUserProfileAttributeKeystring

optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring

optional

The userAttributeMappingId field.

Valuestring

optional

The value field.

DisplayNamestring

optional

The display name of the user.

Emailstring

optional

This is the user's email.

Emailsarray

optional

[]string

This is a list of all of the user's emails from app users.

EmailSourcesarray

optional

[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of source data for the email attribute.

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

AppUserIDstring

optional

The appUserId field.

AppUserProfileAttributeKeystring

optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring

optional

The userAttributeMappingId field.

Valuestring

optional

The value field.

EmployeeIDsarray

optional

[]string

This is a list of all of the user's employee IDs from app users.

EmployeeIDSourcesarray

optional

[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of source data for the employee IDs attribute.

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

AppUserIDstring

optional

The appUserId field.

AppUserProfileAttributeKeystring

optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring

optional

The userAttributeMappingId field.

Valuestring

optional

The value field.

EmploymentStatusstring

optional

The users employment status.

EmploymentStatusSourcesarray

optional

[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of objects mapped based on employmentStatus attribute mappings configured in the system.

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

AppUserIDstring

optional

The appUserId field.

AppUserProfileAttributeKeystring

optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring

optional

The userAttributeMappingId field.

Valuestring

optional

The value field.

EmploymentTypestring

optional

The employment type of the user.

EmploymentTypeSourcesarray

optional

[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of objects mapped based on employmentType attribute mappings configured in the system.

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

AppUserIDstring

optional

The appUserId field.

AppUserProfileAttributeKeystring

optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring

optional

The userAttributeMappingId field.

Valuestring

optional

The value field.

JobTitlestring

optional

The job title of the user.

JobTitleSourcesarray

optional

[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of objects mapped based on jobTitle attribute mappings configured in the system.

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

AppUserIDstring

optional

The appUserId field.

AppUserProfileAttributeKeystring

optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring

optional

The userAttributeMappingId field.

Valuestring

optional

The value field.

ManagerIDsarray

optional

[]string

A list of ids of the user's managers.

ManagerSourcesarray

optional

[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of objects mapped based on managerId attribute mappings configured in the system.

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

AppUserIDstring

optional

The appUserId field.

AppUserProfileAttributeKeystring

optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring

optional

The userAttributeMappingId field.

Valuestring

optional

The value field.

Profilemap

optional

map[string, any]

RoleIDsarray

optional

[]string

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.

StatusC1APIUserV1UserStatusUnknownC1APIUserV1UserStatusC1APIUserV1UserStatusEnabledC1APIUserV1UserStatusC1APIUserV1UserStatusDisabledC1APIUserV1UserStatusC1APIUserV1UserStatusDeletedC1APIUserV1UserStatusC1APIUserV1UserStatus

optional

The status of the user in the system.

Hide ParametersShow Parameters

C1APIUserV1UserStatusUnknownconst

C1APIUserV1UserStatusUnknownC1APIUserV1UserStatusC1APIUserV1UserStatusEnabledC1APIUserV1UserStatusC1APIUserV1UserStatusDisabledC1APIUserV1UserStatusC1APIUserV1UserStatusDeletedC1APIUserV1UserStatusC1APIUserV1UserStatus

"UNKNOWN"

C1APIUserV1UserStatusEnabledconst

C1APIUserV1UserStatusUnknownC1APIUserV1UserStatusC1APIUserV1UserStatusEnabledC1APIUserV1UserStatusC1APIUserV1UserStatusDisabledC1APIUserV1UserStatusC1APIUserV1UserStatusDeletedC1APIUserV1UserStatusC1APIUserV1UserStatus

"ENABLED"

C1APIUserV1UserStatusDisabledconst

C1APIUserV1UserStatusUnknownC1APIUserV1UserStatusC1APIUserV1UserStatusEnabledC1APIUserV1UserStatusC1APIUserV1UserStatusDisabledC1APIUserV1UserStatusC1APIUserV1UserStatusDeletedC1APIUserV1UserStatusC1APIUserV1UserStatus

"DISABLED"

C1APIUserV1UserStatusDeletedconst

C1APIUserV1UserStatusUnknownC1APIUserV1UserStatusC1APIUserV1UserStatusEnabledC1APIUserV1UserStatusC1APIUserV1UserStatusDisabledC1APIUserV1UserStatusC1APIUserV1UserStatusDeletedC1APIUserV1UserStatusC1APIUserV1UserStatus

"DELETED"

TypeC1APIUserV1UserTypeUserTypeUnspecifiedC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeSystemC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeHumanC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeServiceC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeAgentC1APIUserV1UserTypeC1APIUserV1UserType

optional

The type of the user.

Hide ParametersShow Parameters

C1APIUserV1UserTypeUserTypeUnspecifiedconst

C1APIUserV1UserTypeUserTypeUnspecifiedC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeSystemC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeHumanC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeServiceC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeAgentC1APIUserV1UserTypeC1APIUserV1UserType

"USER_TYPE_UNSPECIFIED"

C1APIUserV1UserTypeUserTypeSystemconst

C1APIUserV1UserTypeUserTypeUnspecifiedC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeSystemC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeHumanC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeServiceC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeAgentC1APIUserV1UserTypeC1APIUserV1UserType

"USER_TYPE_SYSTEM"

C1APIUserV1UserTypeUserTypeHumanconst

C1APIUserV1UserTypeUserTypeUnspecifiedC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeSystemC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeHumanC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeServiceC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeAgentC1APIUserV1UserTypeC1APIUserV1UserType

"USER_TYPE_HUMAN"

C1APIUserV1UserTypeUserTypeServiceconst

C1APIUserV1UserTypeUserTypeUnspecifiedC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeSystemC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeHumanC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeServiceC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeAgentC1APIUserV1UserTypeC1APIUserV1UserType

"USER_TYPE_SERVICE"

C1APIUserV1UserTypeUserTypeAgentconst

C1APIUserV1UserTypeUserTypeUnspecifiedC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeSystemC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeHumanC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeServiceC1APIUserV1UserTypeC1APIUserV1UserTypeUserTypeAgentC1APIUserV1UserTypeC1APIUserV1UserType

"USER_TYPE_AGENT"

UpdatedAtTime

optional

formatdate-time

Usernamestring

optional

This is the user's primary username. Typically sourced from the primary directory.

Usernamesarray

optional

[]string

This is a list of all of the user's usernames from app users.

UsernameSourcesarray

optional

[]AppIDstringAppUserIDstringAppUserProfileAttributeKeystringUserAttributeMappingIDstringValuestringC1APIUserV1UserAttributeMappingSource

A list of source data for the usernames attribute.

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

AppUserIDstring

optional

The appUserId field.

AppUserProfileAttributeKeystring

optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring

optional

The userAttributeMappingId field.

Valuestring

optional

The value field.

C1 API User V1 User Attribute Mapping Source

C1APIUserV1UserAttributeMappingSourcestruct

The UserAttributeMappingSource message.

ShowShow

AppIDstring

optional

The appId field.

AppUserIDstring

optional

The appUserId field.

AppUserProfileAttributeKeystring

optional

The appUserProfileAttributeKey field.

UserAttributeMappingIDstring

optional

The userAttributeMappingId field.

Valuestring

optional

The value field.

AppsEntitlementsResource Types

List For App Resource

client.Apps.Entitlements.ResourceTypes.Get(ctx, appResourceID, params) (*ExpandedarrayListarrayNextPageTokenstringC1APIAppV1ListAppEntitlementsResponse, error)

get/api/v1/apps/{app_id}/entitlements/resource_types/{app_resource_type_id}/resources/{app_resource_id}

AppsEntitlementsUsers

List For App User

client.Apps.Entitlements.Users.Get(ctx, appUserID, params) (*ExpandedarrayListarrayNextPageTokenstringC1APIAppV1ListAppEntitlementsResponse, error)

get/api/v1/apps/{app_id}/entitlements/users/{app_user_id}

List Users

Deprecated

client.Apps.Entitlements.Users.List(ctx, appEntitlementID, params) (*ExpandedarrayListarrayNextPageTokenstringAppEntitlementUserListResponse, error)

get/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/users

Remove Grant Duration

client.Apps.Entitlements.Users.RemoveGrantDuration(ctx, appUserID, params) (*BindingC1APIAppV1AppEntitlementUserBindingAppEntitlementUserRemoveGrantDurationResponse, error)

post/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/users/{app_user_id}/remove-grant-duration

List App Users For Identity With Grant

client.Apps.Entitlements.Users.GetGrants(ctx, identityUserID, query) (*BindingsarrayAppEntitlementUserGetGrantsResponse, error)

get/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/users/{identity_user_id}/grants

Update Grant Duration

client.Apps.Entitlements.Users.UpdateGrantDuration(ctx, appUserID, params) (*BindingC1APIAppV1AppEntitlementUserBindingAppEntitlementUserUpdateGrantDurationResponse, error)

post/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/users/{app_user_id}/update-grant-duration

C1 API App V1 App Entitlement User Binding

C1APIAppV1AppEntitlementUserBindingstruct

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

ShowShow

AppEntitlementIDstring

optional

The ID of the app entitlement that the app user has access to

AppIDstring

optional

The ID of the app associated with the app entitlement

AppUserIDstring

optional

The ID of the app user that has access to the app entitlement

CreatedAtTime

optional

formatdate-time

DeletedAtTime

optional

formatdate-time

DeprovisionAtTime

optional

formatdate-time

GrantSourcesarray

optional

[]IDstringAppIDstringAppEntitlementRef

The grantSources field.

Hide ParametersShow Parameters

IDstring

optional

The id field.

AppIDstring

optional

The appId field.

C1 API App V1 App Entitlement User View

C1APIAppV1AppEntitlementUserViewstruct

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

ShowShow

AppEntitlementUserBindingCreatedAtTime

optional

formatdate-time

AppEntitlementUserBindingDeprovisionAtTime

optional

formatdate-time

AppUserAppPathstringAppUserC1APIAppV1AppUserIdentityUserPathstringLastUsagePathstringC1APIAppV1AppUserView

optional

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

GrantSourcesarray

optional

[]IDstringAppIDstringAppEntitlementRef

List of sources for the grant, ie. groups, roles, etc.

Hide ParametersShow Parameters

IDstring

optional

The id field.

AppIDstring

optional

The appId field.

AppsOwners

Set

client.Apps.Owners.New(ctx, appID, body) (*AppOwnerNewResponse, error)

put/api/v1/apps/{app_id}/owners

Add

client.Apps.Owners.Update(ctx, userID, params) (*AppOwnerUpdateResponse, error)

post/api/v1/apps/{app_id}/owners/{user_id}

List

client.Apps.Owners.List(ctx, appID, query) (*ListarrayNextPageTokenstringAppOwnerListResponse, error)

get/api/v1/apps/{app_id}/owners

Remove

client.Apps.Owners.Delete(ctx, userID, params) (*AppOwnerDeleteResponse, error)

delete/api/v1/apps/{app_id}/owners/{user_id}

AppsReport

Generate Report

client.Apps.Report.New(ctx, appID, body) (*AppReportNewResponse, error)

post/api/v1/apps/{app_id}/report

List

client.Apps.Report.List(ctx, appID, query) (*ListarrayNextPageTokenstringAppReportListResponse, error)

get/api/v1/apps/{app_id}/report

AppsResource Types

Create Manually Managed Resource Type

client.Apps.ResourceTypes.New(ctx, appID, body) (*AppResourceTypeC1APIAppV1AppResourceTypeExpandedarrayAppResourceTypeNewResponse, error)

post/api/v1/apps/{app_id}/resource_types

Get

client.Apps.ResourceTypes.Get(ctx, id, query) (*AppResourceTypeViewC1APIAppV1AppResourceTypeViewExpandedarrayAppResourceTypeGetResponse, error)

get/api/v1/apps/{app_id}/resource_types/{id}

Update Manually Managed Resource Type

client.Apps.ResourceTypes.Update(ctx, id, params) (*AppResourceTypeC1APIAppV1AppResourceTypeExpandedarrayAppResourceTypeUpdateResponse, error)

post/api/v1/apps/{app_id}/resource_types/{id}

List

client.Apps.ResourceTypes.List(ctx, appID, query) (*ExpandedarrayListarrayNextPageTokenstringAppResourceTypeListResponse, error)

get/api/v1/apps/{app_id}/resource_types

Delete Manually Managed Resource Type

client.Apps.ResourceTypes.Delete(ctx, id, params) (*AppResourceTypeDeleteResponse, error)

delete/api/v1/apps/{app_id}/resource_types/{id}

C1 API App V1 App Resource Type

C1APIAppV1AppResourceTypestruct

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

ShowShow

IDstring

optional

The unique ID for the app resource type.

AppIDstring

optional

The ID of the app that is associated with the app resource type

CreatedAtTime

optional

formatdate-time

DeletedAtTime

optional

formatdate-time

DisplayNamestring

optional

The display name of the app resource type.

TraitIDsarray

optional

[]string

Associated trait ids

UpdatedAtTime

optional

formatdate-time

C1 API App V1 App Resource Type View

C1APIAppV1AppResourceTypeViewstruct

The AppResourceTypeView message.

ShowShow

AppPathstring

optional

JSONPATH expression indicating the location of the App object in the array

AppResourceTypeIDstringAppIDstringCreatedAtTimeDeletedAtTimeDisplayNamestringTraitIDsarrayUpdatedAtTimeC1APIAppV1AppResourceType

optional

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

AppsResource TypesResources

Create Manually Managed App Resource

client.Apps.ResourceTypes.Resources.New(ctx, appResourceTypeID, params) (*AppResourceC1APIAppV1AppResourceAppResourceTypeResourceNewResponse, error)

post/api/v1/apps/{app_id}/resource_types/{app_resource_type_id}/resources

Get

client.Apps.ResourceTypes.Resources.Get(ctx, id, query) (*AppResourceViewC1APIAppV1AppResourceViewExpandedarrayAppResourceTypeResourceGetResponse, error)

get/api/v1/apps/{app_id}/resource_types/{app_resource_type_id}/resources/{id}

Update

client.Apps.ResourceTypes.Resources.Update(ctx, id, params) (*AppResourceViewC1APIAppV1AppResourceViewExpandedarrayAppResourceTypeResourceUpdateResponse, error)

post/api/v1/apps/{app_id}/resource_types/{app_resource_type_id}/resources/{id}

List

client.Apps.ResourceTypes.Resources.List(ctx, appResourceTypeID, params) (*ExpandedarrayListarrayNextPageTokenstringAppResourceTypeResourceListResponse, error)

get/api/v1/apps/{app_id}/resource_types/{app_resource_type_id}/resources

Delete Manually Managed App Resource

client.Apps.ResourceTypes.Resources.Delete(ctx, id, params) (*AppResourceTypeResourceDeleteResponse, error)

delete/api/v1/apps/{app_id}/resource_types/{app_resource_type_id}/resources/{id}

C1 API App V1 App Resource

C1APIAppV1AppResourcestruct

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

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

• secretTrait

ShowShow

IDstring

optional

The id of the resource.

AppIDstring

optional

The app that this resource belongs to.

AppResourceTypeIDstring

optional

The resource type that this resource is.

CreatedAtTime

optional

formatdate-time

CustomDescriptionstring

optional

A custom description that can be set for a resource.

DeletedAtTime

optional

formatdate-time

Descriptionstring

optional

The description set for the resource.

DisplayNamestring

optional

The display name for this resource.

GrantCountstring

optional

The number of grants to this resource.

formatint64

MatchBatonIDstring

optional

The matchBatonId field.

ParentAppResourceIDstring

optional

The parent resource id, if this resource is a child of another resource.

ParentAppResourceTypeIDstring

optional

The parent resource type id, if this resource is a child of another resource.

SecretTraitIdentityAppUserIDstringLastUsedAtTimeSecretCreatedAtTimeSecretExpiresAtTimeC1APIAppV1AppResourceSecretTrait

optional

The SecretTrait message.

Hide ParametersShow Parameters

IdentityAppUserIDstring

optional

The identityAppUserId field.

LastUsedAtTime

optional

formatdate-time

SecretCreatedAtTime

optional

formatdate-time

SecretExpiresAtTime

optional

formatdate-time

UpdatedAtTime

optional

formatdate-time

C1 API App V1 App Resource View

C1APIAppV1AppResourceViewstruct

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

ShowShow

AppPathstring

optional

JSONPATH expression indicating the location of the App object in the array

AppResourceIDstringAppIDstringAppResourceTypeIDstringCreatedAtTimeCustomDescriptionstringDeletedAtTimeDescriptionstringDisplayNamestringGrantCountstringMatchBatonIDstringParentAppResourceIDstringParentAppResourceTypeIDstringSecretTraitC1APIAppV1AppResourceSecretTraitUpdatedAtTimeC1APIAppV1AppResource

optional

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

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

• secretTrait

ParentResourcePathstring

optional

JSONPATH expression indicating the location of the Parent Resource object in the array

ParentResourceTypePathstring

optional

JSONPATH expression indicating the location of the Parent Resource Type object in the array

ResourceTypePathstring

optional

JSONPATH expression indicating the location of the Resource Type object in the array

AppsResource TypesResourcesOwners

Add

client.Apps.ResourceTypes.Resources.Owners.New(ctx, resourceID, params) (*AppResourceTypeResourceOwnerNewResponse, error)

post/api/v1/apps/{app_id}/resource_types/{resource_type_id}/resource/{resource_id}/owners

List

client.Apps.ResourceTypes.Resources.Owners.List(ctx, resourceID, params) (*ListarrayNextPageTokenstringAppResourceTypeResourceOwnerListResponse, error)

get/api/v1/apps/{app_id}/resource_types/{resource_type_id}/resource/{resource_id}/owners

Remove

client.Apps.ResourceTypes.Resources.Owners.DeleteAll(ctx, resourceID, params) (*AppResourceTypeResourceOwnerDeleteAllResponse, error)

delete/api/v1/apps/{app_id}/resource_types/{resource_type_id}/resource/{resource_id}/owners

AppsUsage Controls

Update

client.Apps.UsageControls.New(ctx, appID, body) (*AppUsageControlsC1APIAppV1AppUsageControlsAppUsageControlNewResponse, error)

post/api/v1/apps/{app_id}/usage_controls

Get

client.Apps.UsageControls.List(ctx, appID) (*AppUsageControlsC1APIAppV1AppUsageControlsHasUsageDataboolAppUsageControlListResponse, error)

get/api/v1/apps/{app_id}/usage_controls

C1 API App V1 App Usage Controls

C1APIAppV1AppUsageControlsstruct

The AppUsageControls object describes some peripheral configuration for an app.

ShowShow

AppIDstring

optional

The app that this object belongs to.

Notifybool

optional

Whether or not to notify some if they have access to the app, but has not used it within a configurable amount of time.

NotifyAfterDaysint64

optional

The duration in days after which we notify users of nonusage.

formatuint32

Revokebool

optional

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.

RevokeAfterDaysint64

optional

The duration in days after which we revoke users that have not used that grant.

formatuint32

AppsUsers

List App Users For User

client.Apps.Users.GetAppUsers(ctx, userID, params) (*ExpandedarrayListarrayNextPageTokenstringAppUserGetAppUsersResponse, error)

get/api/v1/apps/{app_id}/users/{user_id}/app_users