UpdateResource

PATCH/api/v1/resources/{resource}

Update a resource, such as its description or how it syncs.

Example request

US
Europe

curl -X PATCH \
  -H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{ "displayName": "string", "integration": "string" }' \
  "https://us.oblique.security/api/v1/resources/{resource}?updateMask=displayName,integration"

Set OBLIQUE_API_KEY to your API key.

curl -X PATCH \
  -H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{ "displayName": "string", "integration": "string" }' \
  "https://eu.oblique.security/api/v1/resources/{resource}?updateMask=displayName,integration"

Set OBLIQUE_API_KEY to your API key.

Path parameters

resource.namestringrequired
Assigned by Oblique. Name of the resource of the format resources/{id}.

Query parameters

updateMaskstring (field-mask)
The list of fields to update.
allowMissingboolean
If set to true, and the resource is not found, a new resource will be created with the given name. If created in this way, update_mask is ignored.

Request body

displayNamestringrequired
Display name of the resource.
descriptionstring
Description of the resource.
integrationstringrequired
The integration that this resource is associated with.
resourceIdstringread-only
The identifier the integration uses for this resource.

IDs are optional and opaque to clients. They are guarenteed to be unique within the scope of a single integration, but may overlap between integrations.
kindstringread-only
A string representing the value of the metadata oneof. For example, “cloudflare_user_group” or “cloudflare_resource_group”.
createTimestring (date-time)read-only
Create and update timestamps.
updateTimestring (date-time)read-only
deleteTimestring (date-time)read-only
Resources can only be soft-deleted to preserve logs and history. If this field is present, the resource has been deleted and won’t be returned in lists.
managedStartTimestring (date-time)read-only
The time when the resource was first switched to PUSH mode indicating when Oblique started managing the resource as the source of truth. Empty otherwise.
userCountinteger (int32)read-only
The number of users that have either direct or indirect access to this resource.

Note that this will move to status.user_count in the future.
syncModestring
Allowed values: PULL, PUSH, PAUSED
supportsPushbooleanread-only
Whether the integration that reported this resource can push to the object backing it. Determined by the access the integration was granted, and re-evaluated on every sync.
One of
- oktaGroupOktaGroup
  For groups/teams that are sourced from an integration, this field holds information about that object.
  idstring
  The ID of the Okta group. Will be set unless group_create_name is set (indicating Oblique should create a group).
  domainBaseUristring
  Full base URL of the Okta domain, including the schema. For example: https://dev-45752433-admin.okta.com
  groupCreateNamestring
  If provided, the name of a group to be created in Okta.
  groupCreateDescriptionstring
  If provided, the description of the group to be created in Okta.
  groupRulesOktaGroupRule[]
  The set of rules that are applied to the group.
  idstring
  The ID of the rule.
  namestring
  The name of the rule.
  appIdstring
  When the group is an APP_GROUP, this field will be set to the ID of the Okta app that the group is associated with.
  typestring
  Allowed values: APP_GROUP, BUILT_IN, OKTA_GROUP
- oktaAppOktaApp
  idstring
  The ID of the Okta app.
  oinstring
  The Okta Integration Network (OIN) ID of the app.
  domainBaseUristring
  Full base URL of the Okta domain, including the schema. Used to generate a URL to the app. For example: https://dev-45752433-admin.okta.com
  groupAssignmentsstring[]
  The IDs of the Okta groups that are assigned to the app.
  pushesOktaGroupPush[]
  The set of pushes that are applied to the app.
  sourceIdstring
  The ID of the group that is the source of the push.
  targetIdstring
  The ID of the group that is the target of the push.
  appLinksAppLink[]
  The set of app links for launching the app. Most apps have a single entry. Some apps (e.g. Google Workspace) have multiple entries, one per sub-application (e.g. drive, gmail).
  namestring
  The name of the link as defined by Okta, e.g. “login”, “slack_ink”. The name is app-specific and defined by Okta.
  hrefstring
  The URL to launch the app.
  statusstring
  The status of the app in Okta (ACTIVE, INACTIVE, or DELETED).
  groupPushEnabledboolean
  Whether group push is enabled for this app.
- googleGroupGoogleGroup
  idstring
  The immutable, Google assigned ID of the group. Oblique uses this to match the group across syncs. Unset for groups that haven’t been created in Google yet.
  emailstring
  The email of the Google group. Emails change when a group is renamed, so this isn’t a stable identifier for the group.
  nestedGroupsstring[]
  Emails of groups that are nested within this one.
  needsCreationboolean
  If true, the group needs to be created in Google.
- githubTeamGitHubTeam
  slugstring
  The GitHub team slug within the organization.
  nodeIdstring
  The GitHub team node ID.
  orgstring
  The GitHub organization the team belongs to.
- cloudflareUserGroupCloudflareUserGroup
  idstring
  The ID Cloudflare assigns the user group.
- cloudflareResourceGroupCloudflareResourceGroup
  idstring
  The ID Cloudflare assigns the resource group.
  scopeKeystring
  The key of the Cloudflare object the group is scoped under, for example “com.cloudflare.api.account.{account id}”.
  scopeObjectKeysstring[]
  The keys of the objects the group covers within its scope, for example “com.cloudflare.api.account.zone.{zone id}”. A group covering every object in its scope reports none.
- linearWorkspaceLinearWorkspace
  idstring
  The ID Linear assigns the workspace.
  uriKeystring
  The URL key of the workspace, used to build links into Linear. For example “oblique” for https://linear.app/oblique.
- linearTeamLinearTeam
  idstring
  The ID Linear assigns the team.
  parentIdstring
  If present, the parent team’s ID.
  keystring
  The team key, the prefix Linear puts on the team’s issue identifiers. For example “ABC” for the issue “ABC-123”.
- anthropicOrganizationAnthropicOrganization
  idstring
  The ID Anthropic assigns the organization.
- anthropicWorkspaceAnthropicWorkspace
  idstring
  The ID Anthropic assigns the workspace.
syncTimestring (date-time)read-only
The last time this resource was synchronized successfully with its downstream.
statestringread-only
Allowed values: SYNCING, ACTIVE, SUSPENDED, CREATING, RECALCULATING

Response

200Resource

A resource represents a managed resource in the system.

namestring
Assigned by Oblique. Name of the resource of the format resources/{id}.
displayNamestringrequired
Display name of the resource.
descriptionstring
Description of the resource.
integrationstringrequired
The integration that this resource is associated with.
resourceIdstringread-only
The identifier the integration uses for this resource.

IDs are optional and opaque to clients. They are guarenteed to be unique within the scope of a single integration, but may overlap between integrations.
kindstringread-only
A string representing the value of the metadata oneof. For example, “cloudflare_user_group” or “cloudflare_resource_group”.
createTimestring (date-time)read-only
Create and update timestamps.
updateTimestring (date-time)read-only
deleteTimestring (date-time)read-only
Resources can only be soft-deleted to preserve logs and history. If this field is present, the resource has been deleted and won’t be returned in lists.
managedStartTimestring (date-time)read-only
The time when the resource was first switched to PUSH mode indicating when Oblique started managing the resource as the source of truth. Empty otherwise.
userCountinteger (int32)read-only
The number of users that have either direct or indirect access to this resource.

Note that this will move to status.user_count in the future.
syncModestring
Allowed values: PULL, PUSH, PAUSED
supportsPushbooleanread-only
Whether the integration that reported this resource can push to the object backing it. Determined by the access the integration was granted, and re-evaluated on every sync.
One of
- oktaGroupOktaGroup
  For groups/teams that are sourced from an integration, this field holds information about that object.
  idstring
  The ID of the Okta group. Will be set unless group_create_name is set (indicating Oblique should create a group).
  domainBaseUristring
  Full base URL of the Okta domain, including the schema. For example: https://dev-45752433-admin.okta.com
  groupCreateNamestring
  If provided, the name of a group to be created in Okta.
  groupCreateDescriptionstring
  If provided, the description of the group to be created in Okta.
  groupRulesOktaGroupRule[]
  The set of rules that are applied to the group.
  idstring
  The ID of the rule.
  namestring
  The name of the rule.
  appIdstring
  When the group is an APP_GROUP, this field will be set to the ID of the Okta app that the group is associated with.
  typestring
  Allowed values: APP_GROUP, BUILT_IN, OKTA_GROUP
- oktaAppOktaApp
  idstring
  The ID of the Okta app.
  oinstring
  The Okta Integration Network (OIN) ID of the app.
  domainBaseUristring
  Full base URL of the Okta domain, including the schema. Used to generate a URL to the app. For example: https://dev-45752433-admin.okta.com
  groupAssignmentsstring[]
  The IDs of the Okta groups that are assigned to the app.
  pushesOktaGroupPush[]
  The set of pushes that are applied to the app.
  sourceIdstring
  The ID of the group that is the source of the push.
  targetIdstring
  The ID of the group that is the target of the push.
  appLinksAppLink[]
  The set of app links for launching the app. Most apps have a single entry. Some apps (e.g. Google Workspace) have multiple entries, one per sub-application (e.g. drive, gmail).
  namestring
  The name of the link as defined by Okta, e.g. “login”, “slack_ink”. The name is app-specific and defined by Okta.
  hrefstring
  The URL to launch the app.
  statusstring
  The status of the app in Okta (ACTIVE, INACTIVE, or DELETED).
  groupPushEnabledboolean
  Whether group push is enabled for this app.
- googleGroupGoogleGroup
  idstring
  The immutable, Google assigned ID of the group. Oblique uses this to match the group across syncs. Unset for groups that haven’t been created in Google yet.
  emailstring
  The email of the Google group. Emails change when a group is renamed, so this isn’t a stable identifier for the group.
  nestedGroupsstring[]
  Emails of groups that are nested within this one.
  needsCreationboolean
  If true, the group needs to be created in Google.
- githubTeamGitHubTeam
  slugstring
  The GitHub team slug within the organization.
  nodeIdstring
  The GitHub team node ID.
  orgstring
  The GitHub organization the team belongs to.
- cloudflareUserGroupCloudflareUserGroup
  idstring
  The ID Cloudflare assigns the user group.
- cloudflareResourceGroupCloudflareResourceGroup
  idstring
  The ID Cloudflare assigns the resource group.
  scopeKeystring
  The key of the Cloudflare object the group is scoped under, for example “com.cloudflare.api.account.{account id}”.
  scopeObjectKeysstring[]
  The keys of the objects the group covers within its scope, for example “com.cloudflare.api.account.zone.{zone id}”. A group covering every object in its scope reports none.
- linearWorkspaceLinearWorkspace
  idstring
  The ID Linear assigns the workspace.
  uriKeystring
  The URL key of the workspace, used to build links into Linear. For example “oblique” for https://linear.app/oblique.
- linearTeamLinearTeam
  idstring
  The ID Linear assigns the team.
  parentIdstring
  If present, the parent team’s ID.
  keystring
  The team key, the prefix Linear puts on the team’s issue identifiers. For example “ABC” for the issue “ABC-123”.
- anthropicOrganizationAnthropicOrganization
  idstring
  The ID Anthropic assigns the organization.
- anthropicWorkspaceAnthropicWorkspace
  idstring
  The ID Anthropic assigns the workspace.
syncTimestring (date-time)read-only
The last time this resource was synchronized successfully with its downstream.
statestringread-only
Allowed values: SYNCING, ACTIVE, SUSPENDED, CREATING, RECALCULATING

Errors

Status	Meaning
`400`	Malformed request
`401`	Missing or invalid API key
`403`	Not allowed for this API key
`404`	Not found
`429`	Too many requests
`500`	Internal server error