API Reference
Libraries
TypeScript
0.0.1-alpha.0
npm install git+ssh://[email protected]:stainless-sdks/-typescript.git
API Overview
Access Conflict
Create Monitor
post/api/v1/accessconflict
Delete Monitor
delete/api/v1/accessconflict/{id}
Get Monitor
get/api/v1/accessconflict/{id}
Update Monitor
post/api/v1/accessconflict/{id}
AppsAccess Request Defaults
Create App Access Requests Defaults
post/api/v1/apps/{app_id}/access_request_defaults
Get App Access Requests Defaults
get/api/v1/apps/{app_id}/access_request_defaults
Cancel App Access Requests Defaults
post/api/v1/apps/{app_id}/access_request_defaults/cancel
AppsApp Users
Update
post/api/v1/apps/{app_user_app_id}/app_users/{app_user_id}
List
get/api/v1/apps/{app_id}/app_users
List App User Credentials
get/api/v1/apps/{app_id}/app_users/{app_user_id}/credentials
AppsBindings
Get
get/api/v1/apps/{src_app_id}/{src_app_entitlement_id}/bindings/{dst_app_id}/{dst_app_entitlement_id}
Create
post/api/v1/apps/{src_app_id}/{src_app_entitlement_id}/bindings/{dst_app_id}/{dst_app_entitlement_id}
Delete
delete/api/v1/apps/{src_app_id}/{src_app_entitlement_id}/bindings/{dst_app_id}/{dst_app_entitlement_id}
AppsConnectors
Create
post/api/v1/apps/{app_id}/connectors/create
Get
get/api/v1/apps/{app_id}/connectors/{id}
Update
post/api/v1/apps/{app_id}/connectors/{id}
List
get/api/v1/apps/{app_id}/connectors
Delete
delete/api/v1/apps/{app_id}/connectors/{id}
Create Delegated
post/api/v1/apps/{app_id}/connectors
Update Delegated
post/api/v1/apps/{connector_app_id}/connectors/{connector_id}/delegated
Force Sync
post/api/v1/apps/{app_id}/connectors/{connector_id}/force_sync
AppsConnectorsCredentials
Rotate Credential
post/api/v1/apps/{app_id}/connectors/{connector_id}/credentials
Get Credentials
get/api/v1/apps/{app_id}/connectors/{connector_id}/credentials/{id}
Revoke Credential
post/api/v1/apps/{app_id}/connectors/{connector_id}/credentials/{id}
AppsConnectorsValidate Config
Validate Http Connector Config
post/api/v1/apps/connectors/validate_config/http
AppsEntitlements
Create
post/api/v1/apps/{app_id}/entitlements
Get
get/api/v1/apps/{app_id}/entitlements/{id}
Update
post/api/v1/apps/{app_id}/entitlements/{id}
List
get/api/v1/apps/{app_id}/entitlements
Delete
delete/api/v1/apps/{app_id}/entitlements/{id}
Add Manually Managed Members
post/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/add-manual-user
Remove Entitlement Membership
delete/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/remove-membership
Search App Entitlements With Expired
get/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/grants
AppsEntitlementsAutomation
Create Automation
post/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/automation/create
Update Automation
post/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/automation/update
Get Automation
get/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/automation
Delete Automation
delete/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/automation
AppsEntitlementsAutomationExclusions
Add Automation Exclusion
post/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/automation/exclusions
List Automation Exclusions
get/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/automation/exclusions
Remove Automation Exclusion
delete/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/automation/exclusions
AppsEntitlementsResource Types
List For App Resource
get/api/v1/apps/{app_id}/entitlements/resource_types/{app_resource_type_id}/resources/{app_resource_id}
AppsEntitlementsUsers
List For App User
get/api/v1/apps/{app_id}/entitlements/users/{app_user_id}
Remove Grant Duration
post/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/users/{app_user_id}/remove-grant-duration
List App Users For Identity With Grant
get/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/users/{identity_user_id}/grants
Update Grant Duration
post/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/users/{app_user_id}/update-grant-duration
AppsReport
Generate Report
post/api/v1/apps/{app_id}/report
List
get/api/v1/apps/{app_id}/report
AppsResource Types
Create Manually Managed Resource Type
post/api/v1/apps/{app_id}/resource_types
Get
get/api/v1/apps/{app_id}/resource_types/{id}
Update Manually Managed Resource Type
post/api/v1/apps/{app_id}/resource_types/{id}
List
get/api/v1/apps/{app_id}/resource_types
Delete Manually Managed Resource Type
delete/api/v1/apps/{app_id}/resource_types/{id}
AppsResource TypesResources
Create Manually Managed App Resource
post/api/v1/apps/{app_id}/resource_types/{app_resource_type_id}/resources
Get
get/api/v1/apps/{app_id}/resource_types/{app_resource_type_id}/resources/{id}
Update
post/api/v1/apps/{app_id}/resource_types/{app_resource_type_id}/resources/{id}
List
get/api/v1/apps/{app_id}/resource_types/{app_resource_type_id}/resources
Delete Manually Managed App Resource
delete/api/v1/apps/{app_id}/resource_types/{app_resource_type_id}/resources/{id}
AppsResource TypesResourcesOwners
AppsUsers
List App Users For User
get/api/v1/apps/{app_id}/users/{user_id}/app_users
Attributes
Create Attribute Value
post/api/v1/attributes
Get Attribute Value
get/api/v1/attributes/{id}
Delete Attribute Value
delete/api/v1/attribute/{id}
AttributesCompliance Frameworks
Create Compliance Framework Attribute Value
post/api/v1/attributes/compliance_frameworks
Get Compliance Framework Attribute Value
get/api/v1/attributes/compliance_frameworks/{id}
Delete Compliance Framework Attribute Value
delete/api/v1/attributes/compliance_frameworks/{id}
AttributesRisk Levels
Create Risk Level Attribute Value
post/api/v1/attributes/risk_levels
Get Risk Level Attribute Value
get/api/v1/attributes/risk_levels/{id}
Delete Risk Level Attribute Value
delete/api/v1/attributes/risk_levels/{id}
AttributesTypes
List Attribute Types
get/api/v1/attributes/types
List Attribute Values
get/api/v1/attributes/types/{attribute_type_id}/values
Auth
Introspect
get/api/v1/auth/introspect
Automation Executions
Get Automation Execution
get/api/v1/automation_executions/{id}
List Automation Executions
get/api/v1/automation_executions
Search Automation Executions
post/api/v1/automation_executions/search
Automation ExecutionsActions
Terminate Automation
post/api/v1/automation_executions/{id}/actions/terminate
Automation Versions
Search Automation Template Versions
post/api/v1/automation_versions/search
Automations
Create Automation
post/api/v1/automations
Get Automation
get/api/v1/automations/{id}
Update Automation
post/api/v1/automations/{id}
List Automations
get/api/v1/automations
Delete Automation
delete/api/v1/automations/{id}
Execute Automation
post/api/v1/automations/{id}/execute
Search Automations
post/api/v1/automations/search
Catalogs
Create
post/api/v1/catalogs
Get
get/api/v1/catalogs/{id}
Update
post/api/v1/catalogs/{id}
List
get/api/v1/catalogs
Delete
delete/api/v1/catalogs/{id}
Add App Entitlements
post/api/v1/catalogs/{catalog_id}/requestable_entries
Add Access Entitlements
post/api/v1/catalogs/{catalog_id}/visibility_bindings
List Entitlements Per Catalog
get/api/v1/catalogs/{catalog_id}/requestable_entitlements
List Entitlements For Access
get/api/v1/catalogs/{catalog_id}/visibility_entitlements
Remove App Entitlements
delete/api/v1/catalogs/{catalog_id}/requestable_entries
Remove Access Entitlements
delete/api/v1/catalogs/{catalog_id}/visibility_bindings
CatalogsBundle Automation
Create Bundle Automation
post/api/v1/catalogs/{request_catalog_id}/bundle_automation/create
Delete Bundle Automation
delete/api/v1/catalogs/{request_catalog_id}/bundle_automation
Get Bundle Automation
get/api/v1/catalogs/{request_catalog_id}/bundle_automation
Force Run Bundle Automation
post/api/v1/catalogs/{request_catalog_id}/bundle_automation/run
Set Bundle Automation
post/api/v1/catalogs/{request_catalog_id}/bundle_automation
CatalogsRequestable Entries
Grants
Search Grant Feed
post/api/v1/grants/feed
IAM
IAMPersonal Clients
Create
post/api/v1/iam/personal_clients
Get
get/api/v1/iam/personal_clients/{id}
Update
post/api/v1/iam/personal_clients/{id}
NOTE: Only shows personal clients for the current user.
get/api/v1/iam/personal_clients
Delete
delete/api/v1/iam/personal_clients/{id}
PoliciesValidate
Validate Cel
post/api/v1/policies/validate/cel
Search
Search App Resource Types
post/api/v1/search/app_resource_types
Search App Resources
post/api/v1/search/app_resources
Search
post/api/v1/search/app_users
Search Attribute Values
post/api/v1/search/attributes
Search
post/api/v1/search/entitlements
Search Grants
post/api/v1/search/grants
Search Past Grants
post/api/v1/search/past-grants
Search
post/api/v1/search/policies
Search
post/api/v1/search/tasks
Search
post/api/v1/search/users
Search
post/api/v1/search/webhooks
SearchApps
Search
post/api/v1/search/apps
SearchAppsEntitlements
Search App Entitlements For App User
get/api/v1/search/apps/{app_id}/entitlements/users/{app_user_id}
SearchIAM
NOTE: Searches personal clients for all users
post/api/v1/search/iam/personal_clients
SearchRequest Catalog
Search Entitlements
post/api/v1/search/request_catalog/entitlements
SearchSystem Log
Search
post/api/v1/search/systemlog/exports
Settings
Get
get/api/v1/settings/aws-external-id
SettingsSession
Get
get/api/v1/settings/session
Update
post/api/v1/settings/session
Test Source Ip
post/api/v1/settings/session/test-source-ip
Step Up
Get
get/api/v1/step-up/transactions/{id}
System Log
List Events
post/api/v1/systemlog/events
Tasks
Get
get/api/v1/tasks/{id}
Create Grant Task
post/api/v1/task/grant
Create Offboarding Task
post/api/v1/task/offboarding
Create Revoke Task
post/api/v1/task/revoke
List
post/api/v1/task/audits
TasksAction
Approve
post/api/v1/tasks/{task_id}/action/approve
Approve With Step Up
post/api/v1/tasks/{task_id}/action/approve-with-step-up
Close
post/api/v1/tasks/{task_id}/action/close
Comment
post/api/v1/tasks/{task_id}/action/comment
Deny
post/api/v1/tasks/{task_id}/action/deny
Escalate To Emergency Access
post/api/v1/tasks/{task_id}/action/escalate
Hard Reset
post/api/v1/tasks/{task_id}/action/reset
Process Now
post/api/v1/tasks/{task_id}/action/process
Reassign
post/api/v1/tasks/{task_id}/action/reassign
Restart
post/api/v1/tasks/{task_id}/action/restart
Skip Step
post/api/v1/tasks/{task_id}/action/skip-step