Files
developer.sailpoint.com/docs/api/beta/identitynow-beta-api.info.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

48 lines
4.7 KiB
Plaintext

---
id: identitynow-beta-api
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'IdentityNow Beta API' (identitynow-beta-api)"
---
import ApiLogo from "@theme/ApiLogo";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiExplorer/Export";
<span className={"theme-doc-version-badge badge badge--secondary"}>Version: 3.1.0-beta</span>
<Export url={"https://raw.githubusercontent.com/sailpoint-oss/api-specs/main/dereferenced/deref-sailpoint-api.beta.yaml"} proxy={undefined}></Export>
<h1 className={"openapi__heading"}>IdentityNow Beta API</h1>
Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.
<div style={{"marginBottom":"2rem"}}><h2 id={"authentication"} style={{"marginBottom":"1rem"}}>Authentication</h2><SchemaTabs className={"openapi-tabs__security-schemes"}><TabItem label={"OAuth 2.0: UserContextAuth"} value={"UserContextAuth"}>
OAuth2 Bearer token (JWT) generated using either a Personal Access token or through the Authorization Code flow.
See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.
- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)
- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)
- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)
Which authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)
Learn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)
<div><table><tbody><tr><th>Security Scheme Type:</th><td>oauth2</td></tr><tr><th>OAuth Flow (clientCredentials):</th><td><p>Token URL: https://tenant.api.identitynow.com/oauth/token</p><span>Scopes:</span><ul><li>sp:scopes:default: default scope</li><li>sp:scopes:all: access to all scopes</li></ul></td></tr><tr><th>OAuth Flow (authorizationCode):</th><td><p>Token URL: https://tenant.api.identitynow.com/oauth/token</p><p>Authorization URL: https://tenant.login.sailpoint.com/oauth/authorize</p><span>Scopes:</span><ul><li>sp:scopes:default: default scope</li><li>sp:scopes:all: access to all scopes</li></ul></td></tr></tbody></table></div></TabItem><TabItem label={"OAuth 2.0: ApplicationOnlyAuth"} value={"ApplicationOnlyAuth"}>
OAuth2 Bearer token (JWT) generated using client credentials flow.
See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.
- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)
Which authentication method should I choose? See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)
Learn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)
<div><table><tbody><tr><th>Security Scheme Type:</th><td>oauth2</td></tr><tr><th>OAuth Flow (clientCredentials):</th><td><p>Token URL: https://tenant.api.identitynow.com/oauth/token</p><span>Scopes:</span><ul><li>sp:scopes:default: default scope</li></ul></td></tr></tbody></table></div></TabItem></SchemaTabs></div><div style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>Contact</h3><span>Developer Relations: </span><span>URL: <a href={"https://developer.sailpoint.com/discuss/api-help"}>https://developer.sailpoint.com/discuss/api-help</a></span></div><div style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>Terms of Service</h3><a href={"https://developer.sailpoint.com/discuss/tos"}>https://developer.sailpoint.com/discuss/tos</a></div><div style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>License</h3><a href={"https://opensource.org/licenses/MIT"}>MIT</a></div>