Sign in

v5

latestOpenAPI 3.1.02026-07-31151195455.5 KB
resources

Creates a resource. See here for details about importing resources.

post/resources

Request body

namestring required

The name of the remote resource.

descriptionstring

A description of the remote resource.

resource_type'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' | 'NETSUITE_ROLE' | 'DATADOG_ROLE' | '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' | 'VAULT_SECRET' | 'VAULT_POLICY' | 'VAULT_OIDC_ROLE' | 'GIT_HUB_ENTERPRISE_ROLE' | 'GRAFANA_FOLDER' | 'GRAFANA_DASHBOARD' | 'GRAFANA_BASIC_ROLE' | 'GRAFANA_ROLE' | 'CLICKHOUSE_DATABASE' | 'CLICKHOUSE_TABLE' | 'TWINGATE_RESOURCE' | 'ZENDESK_ROLE' | 'HUBSPOT_ROLE' | 'ALICLOUD_RAM_ROLE' | 'ALICLOUD_ECS_INSTANCE' required

The type of the resource.

app_idstring uuid required

The ID of the app for the resource.

remote_resource_idstring

Deprecated - use remote_info instead. The ID of the resource on the remote system. Include only for items linked to remote systems. See this guide for details on how to specify this field.

metadatastring

Deprecated - use remote_info instead.

JSON metadata about the remote resource. Include only for items linked to remote systems. See this guide for details on how to specify this field. The required format is dependent on resource_type and should have the following schema:

<style type="text/css"> code {max-height:300px !important} </style> 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Resource Metadata",
  "properties": {
    "aws_ec2_instance": {
      "properties": {
        "instance_id": {
          "type": "string"
        },
        "region": {
          "type": "string"
        }
      },
      "required": ["instance_id", "region"],
      "additionalProperties": false,
      "type": "object",
      "title": "AWS EC2 Instance"
    },
    "aws_eks_cluster": {
      "properties": {
        "cluster_name": {
          "type": "string"
        },
        "cluster_region": {
          "type": "string"
        },
        "cluster_arn": {
          "type": "string"
        }
      },
      "required": ["cluster_name", "cluster_region", "cluster_arn"],
      "additionalProperties": false,
      "type": "object",
      "title": "AWS EKS Cluster"
    },
    "aws_rds_instance": {
      "properties": {
        "instance_id": {
          "type": "string"
        },
        "engine": {
          "type": "string"
        },
        "region": {
          "type": "string"
        },
        "resource_id": {
          "type": "string"
        },
        "database_name": {
          "type": "string"
        }
      },
      "required": [
        "instance_id",
        "engine",
        "region",
        "resource_id",
        "database_name"
      ],
      "additionalProperties": false,
      "type": "object",
      "title": "AWS RDS Instance"
    },
    "aws_role": {
      "properties": {
        "arn": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": ["arn", "name"],
      "additionalProperties": false,
      "type": "object",
      "title": "AWS Role"
    },
    "gcp_bucket": {
      "properties": {
        "bucket_id": {
          "type": "string"
        }
      },
      "required": ["bucket_id"],
      "additionalProperties": false,
      "type": "object",
      "title": "GCP Bucket"
    },
    "gcp_compute_instance": {
      "properties": {
        "instance_id": {
          "type": "string"
        },
        "project_id": {
          "type": "string"
        },
        "zone": {
          "type": "string"
        }
      },
      "required": ["instance_id", "project_id", "zone"],
      "additionalProperties": false,
      "type": "object",
      "title": "GCP Compute Instance"
    },
    "gcp_folder": {
      "properties": {
        "folder_id": {
          "type": "string"
        }
      },
      "required": ["folder_id"],
      "additionalProperties": false,
      "type": "object",
      "title": "GCP Folder"
    },
    "gcp_gke_cluster": {
      "properties": {
        "cluster_name": {
          "type": "string"
        }
      },
      "required": ["cluster_name"],
      "additionalProperties": false,
      "type": "object",
      "title": "GCP GKE Cluster"
    },
    "gcp_project": {
      "properties": {
        "project_id": {
          "type": "string"
        }
      },
      "required": ["project_id"],
      "additionalProperties": false,
      "type": "object",
      "title": "GCP Project"
    },
    "gcp_sql_instance": {
      "properties": {
        "instance_id": {
          "type": "string"
        },
        "project_id": {
          "type": "string"
        }
      },
      "required": ["instance_id", "project_id"],
      "additionalProperties": false,
      "type": "object",
      "title": "GCP SQL Instance"
    },
    "git_hub_repo": {
      "properties": {
        "org_name": {
          "type": "string"
        },
        "repo_name": {
          "type": "string"
        }
      },
      "required": ["org_name", "repo_name"],
      "additionalProperties": false,
      "type": "object",
      "title": "GitHub Repo"
    },
    "okta_directory_app": {
      "properties": {
        "app_id": {
          "type": "string"
        },
        "logo_url": {
          "type": "string"
        }
      },
      "required": ["app_id", "logo_url"],
      "additionalProperties": false,
      "type": "object",
      "title": "Okta Directory App"
    },
    "okta_directory_role": {
      "properties": {
        "role_type": {
          "type": "string"
        },
        "role_id": {
          "type": "string"
        }
      },
      "required": ["role_type", "role_id"],
      "additionalProperties": false,
      "type": "object",
      "title": "Okta Directory Role"
    },
    "salesforce_profile": {
      "properties": {
        "user_license": {
          "type": "string"
        }
      },
      "required": ["user_license"],
      "additionalProperties": false,
      "type": "object",
      "title": "Salesforce Profile"
    }
  },
  "additionalProperties": false,
  "minProperties": 1,
  "maxProperties": 1,
  "type": "object"
}
custom_request_notificationstring nullable

Custom request notification sent upon request approval.

risk_sensitivity_override'UNKNOWN' | 'CRITICAL' | 'HIGH' | 'MEDIUM' | 'LOW' | 'NONE'

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

Example request

{
  "remote_resource_id": "API_ACCESS_MANAGEMENT_ADMIN-51d203da-313a-4fd9-8fcf-420ce6312345",
  "name": "Okta Engineering Super Admin",
  "description": "Okta super admin role.",
  "resource_type": "OKTA_ROLE",
  "metadata": "{\n  \"okta_directory_role\":\n    {\n      \"role_id\": \"SUPER_ADMIN-b52aa037-4a35-4ac3-9350-f6260fd12345\",\n      \"role_type\": \"SUPER_ADMIN\",\n    },\n}",
  "app_id": "f454d283-ca87-4a8a-bdbb-df212eca5353"
}

Response

The resource just created.

resource_idstring uuid required

The ID of the resource.

app_idstring uuid

The ID of the app.

namestring

The name of the resource.

descriptionstring

A description of the resource.

admin_owner_idstring uuid

The ID of the owner of the resource.

remote_resource_idstring

The ID of the resource on the remote system.

remote_resource_namestring

The name of the resource on the remote system.

resource_type'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' | 'NETSUITE_ROLE' | 'DATADOG_ROLE' | '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' | 'VAULT_SECRET' | 'VAULT_POLICY' | 'VAULT_OIDC_ROLE' | 'GIT_HUB_ENTERPRISE_ROLE' | 'GRAFANA_FOLDER' | 'GRAFANA_DASHBOARD' | 'GRAFANA_BASIC_ROLE' | 'GRAFANA_ROLE' | 'CLICKHOUSE_DATABASE' | 'CLICKHOUSE_TABLE' | 'TWINGATE_RESOURCE' | 'ZENDESK_ROLE' | 'HUBSPOT_ROLE' | 'ALICLOUD_RAM_ROLE' | 'ALICLOUD_ECS_INSTANCE'

The type of the resource.

max_durationinteger

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

recommended_durationinteger

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

extensions_duration_in_minutesinteger

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.

require_manager_approvalboolean

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

require_support_ticketboolean

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

require_mfa_to_approveboolean

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

require_mfa_to_requestboolean

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

require_mfa_to_connectboolean

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

auto_approvalboolean

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

request_template_idstring uuid

The ID of the associated request template.

is_requestableboolean

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

parent_resource_idstring uuid

The ID of the parent resource.

configuration_template_idstring uuid

The ID of the associated configuration template.

custom_request_notificationstring nullable

Custom request notification sent upon request approval.

risk_sensitivity'UNKNOWN' | 'CRITICAL' | 'HIGH' | 'MEDIUM' | 'LOW' | 'NONE'

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

risk_sensitivity_override'UNKNOWN' | 'CRITICAL' | 'HIGH' | 'MEDIUM' | 'LOW' | 'NONE'

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

metadatastring

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

ancestor_resource_idsstring[]

List of resource IDs that are ancestors of this resource.

descendant_resource_idsstring[]

List of resource IDs that are descendants of this resource.

Example response

{
  "resource_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
  "app_id": "b5a5ca27-0ea3-4d86-9199-2126d57d1fbd",
  "description": "This resource represents AWS IAM role \"SupportUser\".",
  "admin_owner_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
  "remote_id": 318038399,
  "remote_name": "repo-name",
  "max_duration": 120,
  "require_manager_approval": false,
  "require_support_ticket": false,
  "parent_resource_id": "f454d283-ca67-4a8a-bdbb-df212eca5345",
  "ancestor_resource_ids": [
    "f454d283-ca67-4a8a-bdbb-df212eca5345"
  ],
  "descendant_resource_ids": [
    "f454d283-ca67-4a8a-bdbb-df212eca5345"
  ]
}