Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

resource_id

string<uuid>

required

The ID of the resource.

Response

200 - application/json

The requested resource.

Resource Object

Description

The Resource object is used to represent a resource.

Usage Example

Update from the UPDATE Resources endpoint.

resource_id

string<uuid>

required

The ID of the resource.

Example:

"f454d283-ca87-4a8a-bdbb-df212eca5353"

app_id

string<uuid>

The ID of the app.

Example:

"b5a5ca27-0ea3-4d86-9199-2126d57d1fbd"

name

string

The name of the resource.

Example:

"mongo-db-prod"

description

string

A description of the resource.

Example:

"This resource represents AWS IAM role \"SupportUser\"."

admin_owner_id

string<uuid>

The ID of the owner of the resource.

Example:

"7c86c85d-0651-43e2-a748-d69d658418e8"

remote_resource_id

string

The ID of the resource on the remote system.

Example:

318038399

remote_resource_name

string

The name of the resource on the remote system.

Example:

"repo-name"

resource_type

enum<string>

The type of the resource.

Available options:

AWS_IAM_ROLE,

AWS_EC2_INSTANCE,

AWS_EKS_CLUSTER,

AWS_RDS_POSTGRES_CLUSTER,

AWS_RDS_POSTGRES_INSTANCE,

AWS_RDS_MYSQL_CLUSTER,

AWS_RDS_MYSQL_INSTANCE,

AWS_ACCOUNT,

AWS_SSO_PERMISSION_SET,

AWS_ORGANIZATIONAL_UNIT,

AZURE_MANAGEMENT_GROUP,

AZURE_RESOURCE_GROUP,

AZURE_SUBSCRIPTION,

AZURE_VIRTUAL_MACHINE,

AZURE_STORAGE_ACCOUNT,

AZURE_STORAGE_CONTAINER,

AZURE_SQL_SERVER,

AZURE_SQL_MANAGED_INSTANCE,

AZURE_SQL_DATABASE,

AZURE_SQL_MANAGED_DATABASE,

AZURE_USER_ASSIGNED_MANAGED_Identity,

AZURE_ENTRA_ID_ROLE,

AZURE_ENTERPRISE_APP,

CUSTOM,

CUSTOM_CONNECTOR,

DATABRICKS_ACCOUNT_SERVICE_PRINCIPAL,

GCP_ORGANIZATION,

GCP_BUCKET,

GCP_COMPUTE_INSTANCE,

GCP_FOLDER,

GCP_GKE_CLUSTER,

GCP_PROJECT,

GCP_CLOUD_SQL_POSTGRES_INSTANCE,

GCP_CLOUD_SQL_MYSQL_INSTANCE,

GCP_BIG_QUERY_DATASET,

GCP_BIG_QUERY_TABLE,

GCP_SERVICE_ACCOUNT,

GIT_HUB_REPO,

GIT_HUB_ORG_ROLE,

GIT_LAB_PROJECT,

GOOGLE_WORKSPACE_ROLE,

MONGO_INSTANCE,

MONGO_ATLAS_INSTANCE,

OKTA_APP,

OKTA_ROLE,

OPAL_ROLE,

OPAL_SCOPED_ROLE,

PAGERDUTY_ROLE,

TAILSCALE_SSH,

SALESFORCE_PERMISSION_SET,

SALESFORCE_PROFILE,

SALESFORCE_ROLE,

SNOWFLAKE_DATABASE,

SNOWFLAKE_SCHEMA,

SNOWFLAKE_TABLE,

WORKDAY_ROLE,

MYSQL_INSTANCE,

MARIADB_INSTANCE,

POSTGRES_INSTANCE,

TELEPORT_ROLE,

ILEVEL_ADVANCED_ROLE,

DATASTAX_ASTRA_ROLE,

COUPA_ROLE,

CURSOR_ORGANIZATION,

OPENAI_PLATFORM_PROJECT,

OPENAI_PLATFORM_SERVICE_ACCOUNT,

ANTHROPIC_WORKSPACE,

GIT_HUB_ORG,

ORACLE_FUSION_ROLE,

DEVIN_ORGANIZATION,

DEVIN_ROLE

Example:

"AWS_IAM_ROLE"

max_duration

integer

The maximum duration for which the resource can be requested (in minutes).

Example:

120

recommended_duration

integer

The recommended duration for which the resource should be requested (in minutes). -1 represents an indefinite duration.

Example:

120

extensions_duration_in_minutes

integer

The duration for which access can be extended (in minutes). Set to 0 to disable extensions. When > 0, extensions are enabled for the specified duration.

Example:

120

require_manager_approval

boolean

deprecated

A bool representing whether or not access requests to the resource require manager approval.

Example:

false

require_support_ticket

boolean

A bool representing whether or not access requests to the resource require an access ticket.

Example:

false

require_mfa_to_approve

boolean

A bool representing whether or not to require MFA for reviewers to approve requests for this resource.

Example:

false

require_mfa_to_request

boolean

A bool representing whether or not to require MFA for requesting access to this resource.

Example:

false

require_mfa_to_connect

boolean

A bool representing whether or not to require MFA to connect to this resource.

Example:

false

auto_approval

boolean

A bool representing whether or not to automatically approve requests to this resource.

Example:

false

request_template_id

string<uuid>

The ID of the associated request template.

Example:

"06851574-e50d-40ca-8c78-f72ae6ab4304"

is_requestable

boolean

A bool representing whether or not to allow access requests to this resource.

Example:

false

parent_resource_id

string<uuid>

The ID of the parent resource.

Example:

"06851574-e50d-40ca-8c78-f72ae6ab4305"

configuration_template_id

string<uuid>

The ID of the associated configuration template.

Example:

"06851574-e50d-40ca-8c78-f72ae6ab4304"

request_configurations

object[]

A list of configurations for requests to this resource.

Show child attributes

request_configurations.allow_requests

boolean

required

A bool representing whether or not to allow requests for this resource.

Example:

true

request_configurations.auto_approval

boolean

required

A bool representing whether or not to automatically approve requests for this resource.

Example:

false

request_configurations.require_mfa_to_request

boolean

required

A bool representing whether or not to require MFA for requesting access to this resource.

Example:

false

request_configurations.require_support_ticket

boolean

required

A bool representing whether or not access requests to the resource require an access ticket.

Example:

false

request_configurations.priority

integer

required

The priority of the request configuration.

Example:

1

request_configurations.condition

object

The condition for the request configuration.

Show child attributes

request_configurations.condition.group_ids

string<uuid>[]

The list of group IDs to match.

Example:

["1b978423-db0a-4037-a4cf-f79c60cb67b3"]

request_configurations.condition.role_remote_ids

string[]

The list of role remote IDs to match.

Example:

[
  "arn:aws:iam::590304332660:role/AdministratorAccess"
]

Example:

{
  "group_ids": ["1b978423-db0a-4037-a4cf-f79c60cb67b3"]
}

request_configurations.max_duration_minutes

integer

The maximum duration for which the resource can be requested (in minutes).

Example:

120

request_configurations.recommended_duration_minutes

integer

The recommended duration for which the resource should be requested (in minutes). -1 represents an indefinite duration.

Example:

120

request_configurations.extensions_duration_in_minutes

integer

The duration for which access can be extended (in minutes). Set to 0 to disable extensions. When > 0, extensions are enabled for the specified duration.

Example:

120

request_configurations.request_template_id

string<uuid>

The ID of the associated request template.

Example:

"06851574-e50d-40ca-8c78-f72ae6ab4304"

request_configurations.reviewer_stages

object[]

The list of reviewer stages for the request configuration.

Show child attributes

request_configurations.reviewer_stages.require_manager_approval

boolean

required

Whether this reviewer stage should require manager approval.

Example:

false

request_configurations.reviewer_stages.operator

enum<string>

required

The operator of the reviewer stage. Admin and manager approval are also treated as reviewers.

Available options:

AND,

OR

Example:

"AND"

request_configurations.reviewer_stages.owner_ids

string<uuid>[]

required

request_configurations.reviewer_stages.require_admin_approval

boolean

Whether this reviewer stage should require admin approval.

Example:

false

request_configuration_list

object[]

deprecated

A list of configurations for requests to this resource. Deprecated in favor of request_configurations.

Show child attributes

request_configuration_list.allow_requests

boolean

required

A bool representing whether or not to allow requests for this resource.

Example:

true

request_configuration_list.auto_approval

boolean

required

A bool representing whether or not to automatically approve requests for this resource.

Example:

false

request_configuration_list.require_mfa_to_request

boolean

required

A bool representing whether or not to require MFA for requesting access to this resource.

Example:

false

request_configuration_list.require_support_ticket

boolean

required

A bool representing whether or not access requests to the resource require an access ticket.

Example:

false

request_configuration_list.priority

integer

required

The priority of the request configuration.

Example:

1

request_configuration_list.condition

object

The condition for the request configuration.

Show child attributes

request_configuration_list.condition.group_ids

string<uuid>[]

The list of group IDs to match.

Example:

["1b978423-db0a-4037-a4cf-f79c60cb67b3"]

request_configuration_list.condition.role_remote_ids

string[]

The list of role remote IDs to match.

Example:

[
  "arn:aws:iam::590304332660:role/AdministratorAccess"
]

Example:

{
  "group_ids": ["1b978423-db0a-4037-a4cf-f79c60cb67b3"]
}

request_configuration_list.max_duration_minutes

integer

The maximum duration for which the resource can be requested (in minutes).

Example:

120

request_configuration_list.recommended_duration_minutes

integer

The recommended duration for which the resource should be requested (in minutes). -1 represents an indefinite duration.

Example:

120

request_configuration_list.extensions_duration_in_minutes

integer

The duration for which access can be extended (in minutes). Set to 0 to disable extensions. When > 0, extensions are enabled for the specified duration.

Example:

120

request_configuration_list.request_template_id

string<uuid>

The ID of the associated request template.

Example:

"06851574-e50d-40ca-8c78-f72ae6ab4304"

request_configuration_list.reviewer_stages

object[]

The list of reviewer stages for the request configuration.

Show child attributes

request_configuration_list.reviewer_stages.require_manager_approval

boolean

required

Whether this reviewer stage should require manager approval.

Example:

false

request_configuration_list.reviewer_stages.operator

enum<string>

required

The operator of the reviewer stage. Admin and manager approval are also treated as reviewers.

Available options:

AND,

OR

Example:

"AND"

request_configuration_list.reviewer_stages.owner_ids

string<uuid>[]

required

request_configuration_list.reviewer_stages.require_admin_approval

boolean

Whether this reviewer stage should require admin approval.

Example:

false

ticket_propagation

object

Configuration for ticket propagation, when enabled, a ticket will be created for access changes related to the users in this resource.

Show child attributes

ticket_propagation.enabled_on_grant

boolean

required

ticket_propagation.enabled_on_revocation

boolean

required

ticket_propagation.ticket_provider

enum<string>

The third party ticketing platform provider.

Available options:

JIRA,

LINEAR,

SERVICE_NOW

Example:

"LINEAR"

ticket_propagation.ticket_project_id

string

custom_request_notification

string | null

Custom request notification sent upon request approval.

Maximum string length: 800

risk_sensitivity

enum<string>

The risk sensitivity level for the resource. When an override is set, this field will match that.

Available options:

UNKNOWN,

CRITICAL,

HIGH,

MEDIUM,

LOW,

NONE

risk_sensitivity_override

enum<string>

Indicates the level of potential impact misuse or unauthorized access may incur.

Available options:

UNKNOWN,

CRITICAL,

HIGH,

MEDIUM,

LOW,

NONE

metadata

string

deprecated

JSON metadata about the remote resource. Only set for items linked to remote systems. See this guide for details.

Example:

"{\n \"okta_directory_role\":\n {\n \"role_id\": \"SUPER_ADMIN-b52aa037-4a35-4ac3-9350-f6260fd12345\",\n \"role_type\": \"SUPER_ADMIN\",\n },\n}"

remote_info

object

Information that defines the remote resource. This replaces the deprecated remote_id and metadata fields.

Show child attributes

remote_info.databricks_account_service_principal

object

Remote info for Databricks account service principal.

Show child attributes

remote_info.databricks_account_service_principal.application_id

string

required

The application ID of the service principal.

Example:

"00000000-0000-0000-0000-000000000000"

remote_info.databricks_account_service_principal.resource_id

string

required

The resource ID of the service principal.

Example:

"00000000-0000-0000-0000-000000000000"

remote_info.azure_subscription

object

Remote info for Azure subscription.

Show child attributes

remote_info.azure_subscription.resource_id

string

required

The ARM resource ID of the subscription.

Example:

"/subscriptions/00000000-0000-0000-0000-000000000000"

remote_info.azure_resource_group

object

Remote info for Azure resource group.

Show child attributes

remote_info.azure_resource_group.resource_id

string

required

The ARM resource ID of the resource group.

Example:

"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-rg"

remote_info.azure_management_group

object

Remote info for Azure management group.

Show child attributes

remote_info.azure_management_group.resource_id

string

required

The ARM resource ID of the management group.

Example:

"/providers/Microsoft.Management/managementGroups/my-mg"

remote_info.azure_virtual_machine

object

Remote info for Azure virtual machine.

Show child attributes

remote_info.azure_virtual_machine.resource_id

string

required

The ARM resource ID of the virtual machine.

Example:

"/subscriptions/0000/resourceGroups/rg/providers/Microsoft.Compute/virtualMachines/vm01"

remote_info.azure_storage_account

object

Remote info for Azure storage account.

Show child attributes

remote_info.azure_storage_account.resource_id

string

required

The ARM resource ID of the storage account.

Example:

"/subscriptions/0000/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/sa01"

remote_info.azure_storage_container

object

Remote info for Azure storage container.

Show child attributes

remote_info.azure_storage_container.resource_id

string

required

The ARM resource ID of the storage container.

Example:

"/subscriptions/0000/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/sa01/blobServices/default/containers/c01"

remote_info.azure_sql_server

object

Remote info for Azure SQL server.

Show child attributes

remote_info.azure_sql_server.resource_id

string

required

The ARM resource ID of the SQL server.

Example:

"/subscriptions/0000/resourceGroups/rg/providers/Microsoft.Sql/servers/sqldev01"

remote_info.azure_sql_database

object

Remote info for Azure SQL database.

Show child attributes

remote_info.azure_sql_database.resource_id

string

required

The ARM resource ID of the SQL database.

Example:

"/subscriptions/0000/resourceGroups/rg/providers/Microsoft.Sql/servers/sqldev01/databases/db01"

remote_info.azure_sql_managed_instance

object

Remote info for Azure SQL managed instance.

Show child attributes

remote_info.azure_sql_managed_instance.resource_id

string

required

The ARM resource ID of the SQL managed instance.

Example:

"/subscriptions/0000/resourceGroups/rg/providers/Microsoft.Sql/managedInstances/mi01"

remote_info.azure_sql_managed_database

object

Remote info for Azure SQL managed database.

Show child attributes

remote_info.azure_sql_managed_database.resource_id

string

required

The ARM resource ID of the SQL managed database.

Example:

"/subscriptions/0000/resourceGroups/rg/providers/Microsoft.Sql/managedInstances/mi01/databases/midb01"

remote_info.azure_user_assigned_managed_identity

object

Remote info for Azure user assigned managed identity.

Show child attributes

remote_info.azure_user_assigned_managed_identity.resource_id

string

required

The ARM resource ID of the user assigned managed identity.

Example:

"/subscriptions/0000/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id01"

remote_info.azure_enterprise_app

object

Remote info for Azure Enterprise App.

Show child attributes

remote_info.azure_enterprise_app.resource_id

string

required

The remote application identifier (service principal or application object ID).

Example:

"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"

remote_info.azure_entra_id_role

object

Remote info for Azure Entra ID role.

Show child attributes

remote_info.azure_entra_id_role.resource_id

string

required

The remote role identifier from Entra (object ID).

Example:

"11111111-2222-3333-4444-555555555555"

remote_info.aws_organizational_unit

object

Remote info for AWS organizational unit.

Show child attributes

remote_info.aws_organizational_unit.organizational_unit_id

string

required

The id of the AWS organizational unit that is being created.

Example:

"ou-1234"

remote_info.aws_organizational_unit.parent_id

string

The id of the parent organizational unit.

Example:

"ou-1234"

remote_info.aws_account

object

Remote info for AWS account.

Show child attributes

remote_info.aws_account.account_id

string

required

The id of the AWS account.

Example:

234234234234

remote_info.aws_account.organizational_unit_id

string

The id of the AWS organizational unit. Required only if customer has OUs enabled.

Example:

"ou-1234"

remote_info.aws_permission_set

object

Remote info for AWS Identity Center permission set.

Show child attributes

remote_info.aws_permission_set.arn

string

required

The ARN of the permission set.

Example:

"arn:aws:sso:::permissionSet/asdf-32139302d201d32/ps-f03323201211e1b9"

remote_info.aws_permission_set.account_id

string

required

The ID of an AWS account to which this permission set is provisioned.

Example:

234234234234

remote_info.aws_iam_role

object

Remote info for AWS IAM role.

Show child attributes

remote_info.aws_iam_role.arn

string

required

The ARN of the IAM role.

Example:

"arn:aws:iam::179308207300:role/MyRole"

remote_info.aws_iam_role.account_id

string

The id of the AWS account. Required for AWS Organizations.

Example:

234234234234

remote_info.aws_ec2_instance

object

Remote info for AWS EC2 instance.

Show child attributes

remote_info.aws_ec2_instance.instance_id

string

required

The instanceId of the EC2 instance.

Example:

"i-13f1a1e2899f9e93a"

remote_info.aws_ec2_instance.region

string

required

The region of the EC2 instance.

Example:

"us-east-2"

remote_info.aws_ec2_instance.account_id

string

The id of the AWS account. Required for AWS Organizations.

Example:

234234234234

remote_info.aws_rds_cluster

object

Remote info for AWS RDS cluster.

Show child attributes

remote_info.aws_rds_cluster.cluster_id

string

required

The clusterId of the RDS cluster.

Example:

"demo-mysql-cluster"

remote_info.aws_rds_cluster.region

string

required

The region of the RDS cluster.

Example:

"us-east-2"

remote_info.aws_rds_cluster.resource_id

string

required

The resourceId of the RDS cluster.

Example:

"cluster-AOO8V0XUCNU13XLZXQDQRSN0NQ"

remote_info.aws_rds_cluster.account_id

string

required

The id of the AWS account. Required for AWS Organizations.

Example:

234234234234

remote_info.aws_rds_cluster.database_name

string

required

The name of the database in the RDS cluster. This can be the value of the tag opal:database-name or the database name.

Example:

"mydatabase"

remote_info.aws_rds_cluster.engine

enum<string>

required

The database engine for the RDS instance.

Available options:

MYSQL,

POSTGRESQL

remote_info.aws_rds_instance

object

Remote info for AWS RDS instance.

Show child attributes

remote_info.aws_rds_instance.instance_id

string

required

The instanceId of the RDS instance.

Example:

"demo-mysql-db"

remote_info.aws_rds_instance.region

string

required

The region of the RDS instance.

Example:

"us-east-2"

remote_info.aws_rds_instance.resource_id

string

required

The resourceId of the RDS instance.

Example:

"db-AOO8V0XUCNU13XLZXQDQRSN0NQ"

remote_info.aws_rds_instance.account_id

string

The id of the AWS account. Required for AWS Organizations.

Example:

234234234234

remote_info.aws_eks_cluster

object

Remote info for AWS EKS cluster.

Show child attributes

remote_info.aws_eks_cluster.arn

string

required

The ARN of the EKS cluster.

Example:

"arn:aws:eks:us-east-2:234234234234:cluster/testcluster"

remote_info.aws_eks_cluster.account_id

string

The id of the AWS account. Required for AWS Organizations.

Example:

234234234234

remote_info.custom_connector

object

Remote info for a custom connector resource.

Show child attributes

remote_info.custom_connector.remote_resource_id

string

required

The id of the resource in the end system

Example:

"01fa7402-01d8-103b-8deb-5f3a0ab7884"

remote_info.custom_connector.can_have_usage_events

boolean

required

A bool representing whether or not the resource can have usage data.

Example:

false

remote_info.gcp_organization

object

Remote info for GCP organization.

Show child attributes

remote_info.gcp_organization.organization_id

string

required

The id of the organization.

Example:

"organizations/898931321"

remote_info.gcp_bucket

object

Remote info for GCP bucket.

Show child attributes

remote_info.gcp_bucket.bucket_id

string

required

The id of the bucket.

Example:

"example-bucket-898931321"

remote_info.gcp_compute_instance

object

Remote info for GCP compute instance.

Show child attributes

remote_info.gcp_compute_instance.instance_id

string

required

The id of the instance.

Example:

"example-instance-898931321"

remote_info.gcp_compute_instance.project_id

string

required

The id of the project the instance is in.

Example:

"example-project-898931321"

remote_info.gcp_compute_instance.zone

string

required

The zone the instance is in.

Example:

"us-central1-a"

remote_info.gcp_big_query_dataset

object

Remote info for GCP BigQuery Dataset.

Show child attributes

remote_info.gcp_big_query_dataset.project_id

string

required

The id of the project the dataset is in.

Example:

"example-project-898931321"

remote_info.gcp_big_query_dataset.dataset_id

string

required

The id of the dataset.

Example:

"example-dataset-898931321"

remote_info.gcp_big_query_table

object

Remote info for GCP BigQuery Table.

Show child attributes

remote_info.gcp_big_query_table.project_id

string

required

The id of the project the table is in.

Example:

"example-project-898931321"

remote_info.gcp_big_query_table.dataset_id

string

required

The id of the dataset the table is in.

Example:

"example-dataset-898931321"

remote_info.gcp_big_query_table.table_id

string

required

The id of the table.

Example:

"example-table-898931321"

remote_info.gcp_folder

object

Remote info for GCP folder.

Show child attributes

remote_info.gcp_folder.folder_id

string

required

The id of the folder.

Example:

"folder/898931321"

remote_info.gcp_gke_cluster

object

Remote info for GCP GKE cluster.

Show child attributes

remote_info.gcp_gke_cluster.cluster_name

string

required

The name of the GKE cluster.

Example:

"example-cluster-898931321"

remote_info.gcp_project

object

Remote info for GCP project.

Show child attributes

remote_info.gcp_project.project_id

string

required

The id of the project.

Example:

"example-project-898931321"

remote_info.gcp_sql_instance

object

Remote info for GCP SQL instance.

Show child attributes

remote_info.gcp_sql_instance.instance_id

string

required

The id of the SQL instance.

Example:

"example-sql-898931321"

remote_info.gcp_sql_instance.project_id

string

required

The id of the project the instance is in.

Example:

"example-project-898931321"

remote_info.gcp_service_account

object

Remote info for a GCP service account.

Show child attributes

remote_info.gcp_service_account.email

string

required

The email of the service account.

Example:

"[email protected]"

remote_info.gcp_service_account.service_account_id

string

required

The id of the service account.

Example:

103561576023829460000

remote_info.gcp_service_account.project_id

string

required

The id of the project the service account is in.

Example:

"example-project-898931321"

remote_info.google_workspace_role

object

Remote info for GCP workspace role.

Show child attributes

remote_info.google_workspace_role.role_id

string

required

The id of the role.

Example:

"google-workspace-role:01234567890123456"

remote_info.github_repo

object

Remote info for GitHub repository.

Show child attributes

remote_info.github_repo.repo_name

string

required

The name of the repository.

Example:

"Opal Security"

remote_info.github_repo.repo_id

string

deprecated

The id of the repository.

Example:

898931321

remote_info.github_org_role

object

Remote info for GitHub organization role.

Show child attributes

remote_info.github_org_role.role_id

string

required

The id of the role.

Example:

112233

remote_info.github_org

object

Remote info for GitHub organization.

Show child attributes

remote_info.github_org.org_name

string

required

The name of the organization.

Example:

"Opal Security"

remote_info.gitlab_project

object

Remote info for Gitlab project.

Show child attributes

remote_info.gitlab_project.project_id

string

required

The id of the project.

Example:

898931321

remote_info.okta_app

object

Remote info for Okta directory app.

Show child attributes

remote_info.okta_app.app_id

string

required

The id of the app.

Example:

"a9dfas0f678asdf67867"

remote_info.okta_standard_role

object

Remote info for Okta directory standard role.

Show child attributes

remote_info.okta_standard_role.role_type

string

required

The type of the standard role.

Example:

"ORG_ADMIN"

remote_info.okta_custom_role

object

Remote info for Okta directory custom role.

Show child attributes

remote_info.okta_custom_role.role_id

string

required

The id of the custom role.

Example:

"a9dfas0f678asdf67867"

remote_info.snowflake_database

object

Remote info for Snowflake database.

Show child attributes

remote_info.snowflake_database.database_name

string

required

The name of the database.

Example:

"mydatabase"

remote_info.snowflake_schema

object

Remote info for Snowflake schema.

Show child attributes

remote_info.snowflake_schema.database_name

string

required

The name of the database the schema is in.

Example:

"mydatabase"

remote_info.snowflake_schema.schema_name

string

required

The name of the schema.

Example:

"mycatalogschema"

remote_info.snowflake_table

object

Remote info for Snowflake table.

Show child attributes

remote_info.snowflake_table.database_name

string

required

The name of the database the table is in.

Example:

"mydatabase"

remote_info.snowflake_table.schema_name

string

required

The name of the schema the table is in.

Example:

"mycatalogschema"

remote_info.snowflake_table.table_name

string

required

The name of the table.

Example:

"myitemstable"

remote_info.ilevel_advanced_role

object

Remote info for iLevel Advanced role.

Show child attributes

remote_info.ilevel_advanced_role.role_name

string

required

The name of the role.

Example:

"IT User"

remote_info.tailscale_ssh

object

Remote info for Tailscale SSH tag.

Show child attributes

remote_info.tailscale_ssh.tag_name

string

required

The name of the tag.

Example:

"admin"

remote_info.pagerduty_role

object

Remote info for Pagerduty role.

Show child attributes

remote_info.pagerduty_role.role_name

string

required

The name of the role.

Example:

"owner"

remote_info.workday_role

object

Remote info for Workday role.

Show child attributes

remote_info.workday_role.role_id

string

required

The id of the role.

Example:

"123abc456def"

remote_info.salesforce_permission_set

object

Remote info for Salesforce permission set.

Show child attributes

remote_info.salesforce_permission_set.permission_set_id

string

required

The id of the permission set.

Example:

"0PS5Y090202wOV7WAM"

remote_info.salesforce_profile

object

Remote info for Salesforce profile.

Show child attributes

remote_info.salesforce_profile.profile_id

string

required

The id of the permission set.

Example:

"0PS5Y090202wOV7WAM"

remote_info.salesforce_profile.user_license_id

string

required

The id of the user license.

Example:

"1005Y030081Qb5XJHS"

remote_info.salesforce_role

object

Remote info for Salesforce role.

Show child attributes

remote_info.salesforce_role.role_id

string

required

The id of the role.

Example:

"0PS5Y090202wOV7WAM"

remote_info.teleport_role

object

Remote info for Teleport role.

Show child attributes

remote_info.teleport_role.role_name

string

required

The name role.

Example:

"admin_role"

remote_info.datastax_astra_role

object

Remote info for an Astra role.

Show child attributes

remote_info.datastax_astra_role.role_id

string

required

The id of the role.

Example:

"123e4567-e89b-12d3-a456-426614174000"

remote_info.coupa_role

object

Remote info for Coupa role.

Show child attributes

remote_info.coupa_role.role_id

string

required

The id of the role.

Example:

999

remote_info.cursor_organization

object

Remote info for a Cursor organization.

Show child attributes

remote_info.cursor_organization.org_id

string

required

The id of the organization.

Example:

"123e4567-e89b-12d3-a456-426614174000"

remote_info.openai_platform_project

object

Remote info for OpenAI Platform project.

Show child attributes

remote_info.openai_platform_project.project_id

string

required

The id of the project.

Example:

"proj_abc"

remote_info.openai_platform_service_account

object

Remote info for OpenAI Platform service account.

Show child attributes

remote_info.openai_platform_service_account.project_id

string

required

The id of the project for the service account.

Example:

"proj_abc"

remote_info.openai_platform_service_account.service_account_id

string

required

The id of the service account.

Example:

"svc_acct_abc"

remote_info.anthropic_workspace

object

Remote info for Anthropic workspace.

Show child attributes

remote_info.anthropic_workspace.workspace_id

string

required

The id of the workspace.

Example:

"ws-123456"

remote_info.oracle_fusion_role

object

Remote info for Oracle Fusion role.

Show child attributes

remote_info.oracle_fusion_role.role_id

string

required

The id of the role.

Example:

"123e4567-e89b-12d3-a456-426614174000"

remote_info.devin_organization

object

Remote info for Devin organization.

Show child attributes

remote_info.devin_organization.org_id

string

required

The id of the organization.

Example:

"devin-org-01"

remote_info.devin_role

object

Remote info for Devin role.

Show child attributes

remote_info.devin_role.role_id

string

required

The id of the role.

Example:

"devin-role-01"

ancestor_resource_ids

string<uuid>[]

List of resource IDs that are ancestors of this resource.

Example:

[
  "f454d283-ca67-4a8a-bdbb-df212eca5345",
  "f454d283-ca67-4a8a-bdbb-df212eca5346"
]

descendant_resource_ids

string<uuid>[]

List of resource IDs that are descendants of this resource.

Example:

[
  "f454d283-ca67-4a8a-bdbb-df212eca5347",
  "f454d283-ca67-4a8a-bdbb-df212eca5348"
]

last_successful_sync

object

Information about the last successful sync of this resource.

Show child attributes

last_successful_sync.id

string<uuid>

required

The ID of the sync task.

Example:

"7c86c85d-0651-43e2-a748-d69d658418e8"

last_successful_sync.completed_at

string<date-time>

required

The time when the sync task was completed.

Example:

"2023-10-01T12:00:00.000Z"

Example:

{
  "id": "7c86c85d-0651-43e2-a748-d69d658418e8",
  "completed_at": "2023-10-01T12:00:00.000Z"
}

API Concepts

SDKs

Opal API

Get resource by ID

Authorizations

Path Parameters

Response

Resource Object

Description

Usage Example