-
checkIndexes
Check the status of a collection's indexes in Mongo
GET /indexes/:collection/statusCheck the status of pre-defined indexes for a specific collection.
-
checkMultipleIndexes
Check the status of multiple collections' indexes in Mongo
GET /indexes/statusCheck the status of pre-defined indexes for multiple collections.
-
createAdapter
Create a new adapter.
POST /adaptersCreate a new adapter in IAP.
-
createBranch
Create a new branch in a repository
POST /git/:gitType/repos/:repoPath/branchesCreate a new branch in a repository
-
createGroup
Create a group.
POST /authorization/groupsCreate a group
-
createGroupMapping
Create a group mapping.
POST /group-mappingsCreate a group mapping
-
createIndexes
Create a collection's indexes in Mongo
POST /indexes/:collectionCreate all pre-defined indexes for a specific collection.
-
createIntegration
Create a new integration.
POST /integrationsCreate a new integration in IAP.
-
createIntegrationModel
Create a new integration model.
POST /integration-modelsCreate a new integration model in IAP.
-
createLink
Update a link.
POST /external-linksCreate a link
-
createProfile
Creates a new profile
POST /profilesCreate a new profile in IAP.
-
createRepo
Create a new repository in Git for storing projects
POST /git/:gitType/repos/:repoPathCreate a new repository in Git for storing projects
-
createRepositoryConfig
Create repository configuration
POST /prebuilts-repository/configsCreate a new repository configuration
-
createRole
Create a role.
POST /authorization/rolesCreate a role
-
createServiceAccount
Create a service account in the database.
POST /oauth/serviceAccountsCreate a service account in the database.
-
createSSOConfig
Create a SSO configuration
POST /sso/configsCreate a SSO configuration
-
deleteAdapter
Delete an adapter.
DELETE /adapters/:nameDelete an adapter from IAP.
-
deleteGroup
Delete a group.
DELETE /authorization/groups/:groupIdDelete a group
-
deleteGroupMapping
Delete a group mapping.
DELETE /group-mappings/:provenance/:externalGroupDelete a group mapping
-
deleteIntegration
Delete an integration.
DELETE /integrations/:nameDelete an integration from IAP.
-
deleteIntegrationModel
Delete an integration model.
DELETE /integration-models/:nameDelete an integration model from IAP.
-
deleteLink
Delete a link.
DELETE /external-links/:linkIdDelete a link
-
deleteProfile
Delete a profile.
DELETE /profiles/:idDelete a profile from IAP.
-
deleteRepositoryConfig
Delete repository configuration
DELETE /prebuilts-repository/configs/:nameDelete an existing repository configuration
-
deleteRole
Delete a role.
DELETE /authorization/roles/:roleIdDelete a role
-
deleteServiceAccount
Deletes a service account in the database.
DELETE /oauth/serviceAccounts/:client_idDeletes a service account in the database.
-
deleteSSOConfig
Delete a SSO configuration
DELETE /sso/configs/:nameDelete a SSO configuration
-
download
Download a public file from IAP
GET /downloadDownload a public file from IAP
-
exportAdapter
Export a single adapter.
GET /adapters/:name/exportExport a single adapter in IAP.
-
exportAuthReport
Extract CSV data of accounts, groups, and roles
GET /authorization/csv/exportRetrieve CSV data of accounts, groups, and roles information
-
exportIntegrationModel
Export an integration model.
GET /integration-models/:name/exportExport an integration model's open API spec.
-
exportPrebuilt
Export a prebuilt
GET /prebuilts/:id/exportExport a prebuilt from IAP.
-
exportProfile
Export a single profile.
GET /profiles/:id/exportExports a single profile in the current IAP.
-
forceLogout
Force a user to logout and remove their session.
POST /authorization/accounts/:accountId/forceLogoutForce a user to logout
-
getAccount
Get an individual account.
GET /authorization/accounts/:accountIdGet an individual account
-
getAccounts
Get all accounts.
GET /authorization/accountsGet all accounts
-
getAdapter
Get a single adapter.
GET /adapters/:nameGet a single adapter in IAP.
-
getAdapterHealth
Get the health of a single adapter.
GET /health/adapters/:nameGet the health of a single adapter in IAP.
-
getAdapterModelTypes
Get the list of available adapter model types.
GET /adapter-models/typesGet the list of available adapter model types in the current IAP.
-
getAdapters
Get all adapters.
GET /adaptersGet all adapters in IAP.
-
getAdapterSchema
Get the adapter schema.
GET /schema/adapters/:nameGet the adapter schema.
-
getAdaptersHealth
Get the health of all the adapters.
GET /health/adaptersGet the health of all the adapters in IAP.
-
getAdaptersHtml
Generate documentation for adapters
GET /help/adapters/htmlGenerate an HTML documentation page for adapters
-
getApplication
Get a single application.
GET /applications/:nameGet a single application in IAP.
-
getApplicationConfigs
Get all application configs in IAP.
GET /config/appsGet all application configs in IAP.
-
getApplicationHealth
Get the health of a single application.
GET /health/applications/:nameGet the health of a single application in IAP.
-
getApplications
Get all applications.
GET /applicationsGet all applications in IAP.
-
getApplicationSchema
Get the application schema.
GET /schema/applications/:nameGet the application schema.
-
getApplicationsHealth
Get the health of all the applications.
GET /health/applicationsGet the health of all the applications in IAP.
-
getApplicationsHtml
Generate documentation for applications
GET /help/applications/htmlGenerate an HTML documentation page for applications
-
getBanner
Get banner.
GET /customization/bannerGet banner for customization
-
getBrokerMap
Get a mapping between brokers and adapters.
GET /adapters/brokers/mappingGet a mapping between brokers and adapters.
-
getBrokersHtml
Generate documentation for brokers
GET /help/brokers/htmlGenerate an HTML documentation page for brokers
-
getDeviceCounts
Get device count history
GET /device-countsGet device count history
-
getGroup
Get an individual group.
GET /authorization/groups/:groupIdGet an individual group
-
getGroupMapping
Get an individual group mapping.
GET /group-mappings/:provenance/:externalGroupGet an individual group mapping
-
getGroupMappings
Get all group mappings.
GET /group-mappingsGet all group mappings
-
getGroups
Get a list of groups.
GET /authorization/groupsGet a list of groups
-
getGroupsShortList
Get a simplified list of groups.
GET /authorization/groups/listGet a simplified list of groups
-
getHealthStatus
Get status.
GET /health/statusGet status of current IAP.
-
getIndexes
Get all pre-defined indexes.
GET /indexesGet all pre-defined indexes to be used in Mongo.
-
getIntegration
Get a single integration.
GET /integrations/:nameGet a single integration in IAP.
-
getIntegrationModel
Get a specific integration model.
GET /integration-models/:nameGet a specific integration model in IAP.
-
getIntegrationModels
Get all integration models.
GET /integration-modelsGet all the integration models in IAP.
-
getIntegrations
Get all integrations.
GET /integrationsGet all integrations in IAP.
-
getIntegrationSchema
Get the integration schema.
GET /schema/integrations/:nameGet the integration schema.
-
getLink
Get an individual link.
GET /external-links/:linkIdGet an individual link
-
getLinks
Get all links.
GET /external-linksGet all links
-
getMethods
Get a list of methods.
GET /authorization/methodsGet a list of methods in IAP.
-
getMyPrincipal
Gets the principal document for the active user
GET /myPrincipalGets the principal for the active user
-
getMySession
Gets the session document for the active user
GET /mySessionGets the session for the active user
-
getMyTtl
Get the number of seconds until the logged in user's session expires.
GET /myTtlGet the number of seconds until the user is logged out.
-
getOpenApi
Generate an OpenAPI v3 document for IAP
GET /help/openapiGenerate an OpenAPI v3.1.0 document for IAP
-
getPrebuilt
Get a single prebuilt.
GET /prebuilts/:idGet a single prebuilt in IAP.
-
getPrebuilts
Get all the prebuilts.
GET /prebuiltsGet all the prebuilts in IAP.
-
getProfile
Get a single profile.
GET /profiles/:idGet a single profile in the current IAP.
-
getProfiles
Get all profiles.
GET /profilesGet all the profiles in IAP.
-
getProfileSchema
Get the profile schema.
GET /schema/profilesGet the profile schema.
-
getProject
Retrieve a project from Git
GET /git/:gitType/repos/:repoPath/branches/:branchName/projects/:projectPathRetrieve a project from Git
-
getPrometheusMetrics
Get prometheus metrics.
GET /prometheus_metricsBuilds and returns all prometheus metrics.
-
getReleaseVersion
Get verion.
GET /versionGet release verion of current IAP.
-
getRepositoryConfigs
Get Repository Configurations
GET /prebuilts-repository/configsGet all the Prebuilt Repository configurations
-
getRepositoryPrebuilts
Get all prebuilts
GET /prebuilts-repositoryGet all prebuilts from a repository.
-
getRole
Get an individual role.
GET /authorization/roles/:roleIdGet an individual role
-
getRoles
Get a list of roles.
GET /authorization/rolesGet a list of roles
-
getServerHealth
Get the health of the server.
GET /health/serverGet the health of the server.
-
getServiceAccounts
Get service accounts from the database.
GET /oauth/serviceAccountsGet service accounts from the database.
-
getSSOConfig
Get a single SSO configuration
GET /sso/configs/:nameGet a single SSO configuration
-
getSSOConfigs
Get all SSO configurations
GET /sso/configsGet all SSO configurations
-
getSystemHealth
Get the health of the system.
GET /health/systemGet the health of the system.
-
getSystemId
Get system server id.
GET /system/idGet system server id for the current IAP.
-
getUserSettings
Gets the user settings for the active user
GET /user/settingsGets the user settings for the active user
-
getViews
Get a list of views.
GET /authorization/viewsGet a list of views in IAP.
-
importAdapter
Import a new adapter.
POST /adapters/importImport a new adapter in IAP.
-
importPrebuilt
Import a prebuilt.
POST /prebuilts/importImport a prebuilt into IAP.
-
importProfile
Import a new profile
POST /profiles/importImport a new profile in IAP.
-
initProject
Initialize a project in Git
POST /git/:gitType/repos/:repoPath/branches/:branchName/projects/:projectPathInitialize a project in Git
-
isSSOEnabled
Get whether or not single sign on is enabled
GET /sso/enabledGet whether or not single sign on is enabled
-
listBranches
List the available branches for a repository
GET /git/:gitType/repos/:repoPath/branchesList the available branches for a repository
-
login
Log in an create a session in IAP
POST /loginLog in to IAP
-
logout
Log out of IAP and delete current session
GET /logoutLog out of IAP
-
machineAuthentication
Retrieve a JWT from a client's credentials
POST /oauth/tokenRetrieve a JWT from a client's credentials
-
regenerateSecret
Regenerates the client_secret and returns the new value
PATCH /oauth/serviceAccounts/:client_id/regenerateRegenerates the client_secret and returns the new value
-
removePrebuilt
Remove a prebuilt.
DELETE /prebuilts/:idRemove a prebuilt from IAP.
-
restartAdapter
Restart an adapter.
PUT /adapters/:name/restartRestart an adapter in IAP.
-
restartApplication
Restart an application.
PUT /applications/:name/restartRestart an application in IAP.
-
samlCallback
This the route used by the SAML identity provider to callback to IAP with the authentication response. This is not meant for manual use.
POST /saml/callbackCallback used by the SAML identity provider
-
sso
Log in and create a session in IAP using single sign on
GET /ssoLog into IAP using single sign on
-
ssoTest
Test logging into IAP using a saved single sign on configuration
GET /sso/test/:nameTest logging into IAP using single sign on
-
startAdapter
Start an adapter.
PUT /adapters/:name/startStart an adapter in IAP.
-
startApplication
Start an application.
PUT /applications/:name/startStart an application in IAP.
-
stopAdapter
Stop an adapter.
PUT /adapters/:name/stopStop an adapter in IAP.
-
stopApplication
Stop an application.
PUT /applications/:name/stopStop an application in IAP.
-
switchActiveProfile
Switch the active profile.
PUT /profiles/:id/activeSwitch the active profile in the current IAP.
-
updateAccount
Update an account.
PATCH /authorization/accounts/:accountIdUpdate an account
-
updateAdapter
Update an adapter.
PUT /adapters/:nameUpdate an adapter in IAP.
-
updateAdapterLogging
Update the log levels.
PUT /adapters/:name/loglevelUpdate the log levels for an adapter.
-
updateAdapterProperties
Update the properties of an adapter.
PUT /adapters/:name/propertiesUpdate the properties of an adapter in IAP.
-
updateApplication
Update an application.
PUT /applications/:nameUpdate an application in IAP.
-
updateApplicationLogging
Update the log levels.
PUT /applications/:name/loglevelUpdate the log levels for an application.
-
updateApplicationProperties
Update the properties of an application.
PUT /applications/:name/propertiesUpdate the properties of an application in IAP.
-
updateBanner
Update the banner.
PUT /customization/bannerUpdate the banner
-
updateGroup
Update a group.
PATCH /authorization/groups/:groupIdUpdate a group
-
updateGroupMapping
Update a group mapping.
PATCH /group-mappings/:provenance/:externalGroupUpdate a group mapping
-
updateIntegration
Update an integration.
PUT /integrations/:nameUpdate an integration in IAP.
-
updateIntegrationModel
Update an integration model.
PUT /integration-modelsUpdate an integration model in IAP.
-
updateIntegrationProperties
Update the properties of an integration.
PUT /integrations/:name/propertiesUpdate the properties of an integration in IAP.
-
updateLink
Update a link.
PATCH /external-links/:linkIdUpdate a link
-
updatePrebuilt
Update a prebuilt
PUT /prebuilts/:idUpdate a prebuilt in IAP.
-
updateProfile
Updates a profile.
PUT /profiles/:idUpdate a profile in IAP.
-
updateProject
Update a project in Git
PUT /git/:gitType/repos/:repoPath/branches/:branchName/projects/:projectPathUpdate a project in Git
-
updateRepositoryConfig
Update repository configuration
PATCH /prebuilts-repository/configs/:nameUpdate an existing repository configuration
-
updateRole
Update a role.
PATCH /authorization/roles/:roleIdUpdate a role
-
updateServiceAccount
Updates a service account in the database.
PATCH /oauth/serviceAccounts/:client_idUpdates a service account in the database.
-
updateSSOConfig
Update a SSO configuration
PUT /sso/configs/:nameUpdate a SSO configuration
-
updateUserSettings
Updates the user settings for the active user
PATCH /user/settingsUpdates the user settings for the active user
-
validateIntegrationModel
Validate an integration model.
PUT /integration-models/validationValidate an integration model.
-
validatePrebuilt
Validate the data structure of a prebuilt.
PUT /prebuilts/import/validationValidate the data structure of a prebuilt in IAP.
-
whoAmI
Gets the authorization data for the logged in user
GET /whoamiGets the authorization data for the logged in user
2023.2 (latest)