LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

moved items around on sidebar and changed sidebar config

Browse Source
This commit is contained in:
jordan-violet-sp
2022-09-12 10:37:12 -04:00
parent 008ae68a53
commit e78d3ca355
7 changed files with 97 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docusaurus.config.js
View File

@@ -57,7 +57,7 @@ const config = {
docs: { docs: {
sidebar: { sidebar: {
hideable: true, hideable: true,
autoCollapseCategories: false, autoCollapseCategories: true,
}, },
}, },
colorMode: { colorMode: {

4
products/idn/docs/getting-started/_category_.json Normal file
View File

@@ -0,0 +1,4 @@
{
"collapsed": false,
"collapsible": false
}

73
products/idn/docs/getting-started/index.md
View File

@@ -5,9 +5,74 @@ title: Getting Started
sidebar_position: 1 sidebar_position: 1
--- ---
```mdx-code-block # Getting Started with SailPoint APIs
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/> ## Finding your Org/Tenant Name
You will need to know your org/tenant name in order to form the proper URL for an API request. You can find your org/tenant name by logging into IdentityNow, navigating to the Admin UI, and clicking on the Dashboard dropdown and selecting the Overview page. The org name is displayed within the Org Details section of the dashboard. If you do not have admin access, you can find your tenant name, as well as the API base URL that you will use for API calls, by viewing your session details when logged into your IdentityNow instance. Simply change your URL to the following: `https://{your-IdentityNow-hostname}.com/ui/session`, where `{your-IdentityNow-hostname}` is your company's domain name for accessing IdentityNow. The session detail you want is the `baseUrl`, which will have the form of `https://{tenant}.api.identitynow.com`.
## Making Your First API Call
To get started, you will need create a [personal access token](./authentication.md#personal-access-tokens), which can then be used to generate access tokens to authenticate your API calls. To generate a personal access token from the IdentityNow UI, perform the following steps after logging into your IdentityNow instance:
1. Select **Preferences** from the drop-down menu under your username, then **Personal Access Tokens** on the left. You can also go straight to the page using this URL, replacing `{tenant}` with your IdentityNow tenant: `https://{tenant}.identitynow.com/ui/d/user-preferences/personal-access-tokens`.
2. Click **New Token** and enter a meaningful description to help differentiate the token from others.
>**Note**: The **New Token** button will be disabled when you’ve reached the limit of 10 personal access tokens per user. To avoid reaching this limit, we recommend you delete any tokens that are no longer needed.
3. Click **Create Token** to generate and view the two components that comprise the token: the `Secret` and the `Client ID`.
>**IMPORTANT**: After you create the token, the value of the `Client ID` will be visible in the Personal Access Tokens list, but the corresponding `Secret` will not be visible after you close the window. You will need to store the `Secret` somewhere secure.
4. Copy both values somewhere that will be secure and accessible to you when you need to use the the token.
5. To create an `access_token` that can be used to authenticate API requests, use the following cURL command, replacing `{tenant}` with your IdentityNow tenant. The response body will contain an `access_token`, which will look like a long string of random characters.
```sh
curl --location --request POST 'https://{tenant}.api.identitynow.com/oauth/token?grant_type=client_credentials&client_id={client_id}&client_secret={secret}'
```
6. To test your `access_token`, execute the following cURL command, replacing `{tenant}` with your IdentityNow tenant and `access_token` with the token you generated in the previous step. If successful, you should get a JSON representation of an identity in your tenant.
```sh
curl --request GET --url 'https://{tenant}.api.identitynow.com/v3/public-identities?limit=1' --header 'authorization: Bearer {access_token}'
```
For more information about SailPoint Platform authentication, see [API Authentication](./authentication.md)
## Rate Limits
There is a rate limit of 100 requests per `access_token` per 10 seconds for V3 API calls through the API gateway. If you exceed the rate limit, expect the following response from the API.
**HTTP Status Code**: 429 Too Many Requests
**Headers**:
* **Retry-After**: {seconds to wait before rate limit resets}
## Authorization
Each API resource requires a specific level of authorization attached to your `access_token`. Please review the authorization constraints for each API endpoint. Tokens generated outside of a user context, like the [Client Credentials](./authentication.md#client-credentials-grant-flow) we generated above to make your first API call, will be limited in the endpoints that it can call. If your token doesn't have permission to call an endpoint, you will receive the following response:
**HTTP Status Code**: 403 Forbidden
**Response Body**:
```JSON
{
"detailCode": "403 Forbidden",
"trackingId": "fca9eb2227514d6d90cd4a1d1cdc255c",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The server understood the request but refuses to authorize it."
}
]
}
``` ```
## Using an API Tool
There are several API tools that make exploring and testing APIs easier than using the command line or a programming language. One such tool is [Postman](https://www.postman.com/downloads/). To import the SailPoint REST APIs into a tool like Postman, you must first download the REST specification. Navigate to [https://developer.sailpoint.com/apis/v3](https://developer.sailpoint.com/apis/v3) and click the "Download OpenAPI specification" button. You can then import the JSON file in Postman by using the [import wizard](https://learning.postman.com/docs/getting-started/importing-and-exporting-data/) within Postman.

78
products/idn/docs/getting-started/overview.md
View File

@@ -1,78 +0,0 @@
---
id: overview
slug: /docs/overview
title: Overview
sidebar_position: 1
---
# Getting Started with SailPoint APIs
## Finding your Org/Tenant Name
You will need to know your org/tenant name in order to form the proper URL for an API request. You can find your org/tenant name by logging into IdentityNow, navigating to the Admin UI, and clicking on the Dashboard dropdown and selecting the Overview page. The org name is displayed within the Org Details section of the dashboard. If you do not have admin access, you can find your tenant name, as well as the API base URL that you will use for API calls, by viewing your session details when logged into your IdentityNow instance. Simply change your URL to the following: `https://{your-IdentityNow-hostname}.com/ui/session`, where `{your-IdentityNow-hostname}` is your company's domain name for accessing IdentityNow. The session detail you want is the `baseUrl`, which will have the form of `https://{tenant}.api.identitynow.com`.
## Making Your First API Call
To get started, you will need create a [personal access token](./authentication.md#personal-access-tokens), which can then be used to generate access tokens to authenticate your API calls. To generate a personal access token from the IdentityNow UI, perform the following steps after logging into your IdentityNow instance:
1. Select **Preferences** from the drop-down menu under your username, then **Personal Access Tokens** on the left. You can also go straight to the page using this URL, replacing `{tenant}` with your IdentityNow tenant: `https://{tenant}.identitynow.com/ui/d/user-preferences/personal-access-tokens`.
2. Click **New Token** and enter a meaningful description to help differentiate the token from others.
>**Note**: The **New Token** button will be disabled when you’ve reached the limit of 10 personal access tokens per user. To avoid reaching this limit, we recommend you delete any tokens that are no longer needed.
3. Click **Create Token** to generate and view the two components that comprise the token: the `Secret` and the `Client ID`.
>**IMPORTANT**: After you create the token, the value of the `Client ID` will be visible in the Personal Access Tokens list, but the corresponding `Secret` will not be visible after you close the window. You will need to store the `Secret` somewhere secure.
4. Copy both values somewhere that will be secure and accessible to you when you need to use the the token.
5. To create an `access_token` that can be used to authenticate API requests, use the following cURL command, replacing `{tenant}` with your IdentityNow tenant. The response body will contain an `access_token`, which will look like a long string of random characters.
```sh
curl --location --request POST 'https://{tenant}.api.identitynow.com/oauth/token?grant_type=client_credentials&client_id={client_id}&client_secret={secret}'
```
6. To test your `access_token`, execute the following cURL command, replacing `{tenant}` with your IdentityNow tenant and `access_token` with the token you generated in the previous step. If successful, you should get a JSON representation of an identity in your tenant.
```sh
curl --request GET --url 'https://{tenant}.api.identitynow.com/v3/public-identities?limit=1' --header 'authorization: Bearer {access_token}'
```
For more information about SailPoint Platform authentication, see [API Authentication](./authentication.md)
## Rate Limits
There is a rate limit of 100 requests per `access_token` per 10 seconds for V3 API calls through the API gateway. If you exceed the rate limit, expect the following response from the API.
**HTTP Status Code**: 429 Too Many Requests
**Headers**:
* **Retry-After**: {seconds to wait before rate limit resets}
## Authorization
Each API resource requires a specific level of authorization attached to your `access_token`. Please review the authorization constraints for each API endpoint. Tokens generated outside of a user context, like the [Client Credentials](./authentication.md#client-credentials-grant-flow) we generated above to make your first API call, will be limited in the endpoints that it can call. If your token doesn't have permission to call an endpoint, you will receive the following response:
**HTTP Status Code**: 403 Forbidden
**Response Body**:
```JSON
{
"detailCode": "403 Forbidden",
"trackingId": "fca9eb2227514d6d90cd4a1d1cdc255c",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The server understood the request but refuses to authorize it."
}
]
}
```
## Using an API Tool
There are several API tools that make exploring and testing APIs easier than using the command line or a programming language. One such tool is [Postman](https://www.postman.com/downloads/). To import the SailPoint REST APIs into a tool like Postman, you must first download the REST specification. Navigate to [https://developer.sailpoint.com/apis/v3](https://developer.sailpoint.com/apis/v3) and click the "Download OpenAPI specification" button. You can then import the JSON file in Postman by using the [import wizard](https://learning.postman.com/docs/getting-started/importing-and-exporting-data/) within Postman.

1
products/idn/docs/transforms/transforms.md → products/idn/docs/transforms/index.md
View File

@@ -2,6 +2,7 @@
id: transforms id: transforms
slug: /docs/transforms slug: /docs/transforms
title: Transforms title: Transforms
sidebar_position: 2
--- ---
# Building Transforms in IdentityNow # Building Transforms in IdentityNow

63
products/idn/docs/transforms/operations/operations.md → products/idn/docs/transforms/operations/index.md
View File

@@ -3,15 +3,8 @@ id: operations
slug: /docs/transforms/operations slug: /docs/transforms/operations
title: Operations title: Operations
--- ---
# Operations in Identity Now
Transforms allow you to manipulate attribute values while aggregating from or provisioning to a source. Transforms allow you to manipulate attribute values while aggregating from or provisioning to a source. You can find more information about the use and construction of transforms in [Building Transforms in IdentityNow](../building_transforms/building_transforms.md#building-transforms-in-identitynow). This document lists each type of operation you can perform in a transform and examples of their uses. Sometimes you will hear these transforms referred to as **Seaspray**, which is the code-name for transforms. IdentityNow Transforms and Seaspray are essentially the same thing.
You can find more information about the use and construction of transforms in [Building Transforms in IdentityNow](../building_transforms/building_transforms.md#building-transforms-in-identitynow).
This document lists each type of operation you can perform in a transform and examples of their uses.
Sometimes you will hear these transforms referred to as **Seaspray**, which is the code-name for transforms. IdentityNow Transforms and Seaspray are essentially the same thing.
The general form of a transform definition is the following form: The general form of a transform definition is the following form:
@@ -27,49 +20,6 @@ The general form of a transform definition is the following form:
Attribute values can be any JSON value, including nested transforms and primitive operations. You can use a special attribute, "input," to seed the input value for a transform instead of deriving it from the transform context. Attribute values can be any JSON value, including nested transforms and primitive operations. You can use a special attribute, "input," to seed the input value for a transform instead of deriving it from the transform context.
## Transform Operations
Seaspray ships out of the box with a number of primitive operations. The following sections describe the operations.
**Operations:**
* [Account Attribute](./operations/account_attribute.md)
* [Base64 Decode](./operations/base64_decode.md)
* [Base64 Encode](./operations/base64_encode.md)
* [Concatenation](./operations/concatenation.md)
* [Conditional](./operations/conditional.md)
* [Date Compare](./operations/date_compare.md)
* [Date Format](./operations/date_format.md)
* [Date Math](./operations/date_math.md)
* [Decompose Diacritial Marks](./operations/decompose_diacritical_marks.md)
* [E.164 Phone](./operations/e164_phone.md)
* [First Valid](./operations/first_valid.md)
* [Generate Random String](./operations/generate_random_string.md)
* [Get End of String](./operations/get_end_of_string.md)
* [Get Reference Identity Attribute](./operations/get_reference_identity_attribute.md)
* [Identity Attribute](./operations/identity_attribute.md)
* [Index Of](./operations/index_of.md)
* [ISO3166](./operations/iso_3166.md)
* [Last Index Of](./operations/last_index_of.md)
* [Left Pad](./operations/left_pad.md)
* [Lookup](./operations/lookup.md)
* [Lower](./operations/lower.md)
* [Name Normalizer](./operations/name_normalizer.md)
* [Random Alphanumeric](./operations/random_alphanumeric.md)
* [Random Numeric](./operations/random_numeric.md)
* [Reference](./operations/reference.md)
* [Replace All](./operations/replace_all.md)
* [Replace](./operations/replace.md)
* [Right Pad](./operations/right_pad.md)
* [Rule](./operations/rule.md)
* [Split](./operations/split.md)
* [Static](./operations/substring.md)
* [Substring](./operations/trim.md)
* [Trim](./operations/trim.md)
* [Upper](./operations/upper.md)
* [Username Generator](./operations/username_generator.md)
* [UUID Generator](./operations/uuid_generator.md)
## Template Engine ## Template Engine
Seaspray ships with the Apache Velocity template engine that allows a transform to reference, transform, and render values passed into the transform context. Every string value in a Seaspray transform can contain templated text and will run through the template engine. Seaspray ships with the Apache Velocity template engine that allows a transform to reference, transform, and render values passed into the transform context. Every string value in a Seaspray transform can contain templated text and will run through the template engine.
@@ -97,3 +47,14 @@ The following variables are available to the Apache Velocity template engine whe
* **identity** - sailpoint.object.Identity - This is the identity the account profile is generating for. * **identity** - sailpoint.object.Identity - This is the identity the account profile is generating for.
* **application** - sailpoint.object.Application - This is the application backing the source that owns the account profile. * **application** - sailpoint.object.Application - This is the application backing the source that owns the account profile.
* **current** - Object - This is the attribute's current value. * **current** - Object - This is the attribute's current value.
## Transform Operations
Seaspray ships out of the box with a number of primitive operations. The following sections describe the operations.
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```

11
products/idn/sidebar.js
View File

@@ -43,8 +43,15 @@ const sidebars = {
], ],
idnDocs: [ idnDocs: [
{ {
type: "autogenerated", type: "category",
dirName: "docs", label: "IdentityNow",
collapsible: false,
items: [
{
type: "autogenerated",
dirName: "docs",
},
]
}, },
], ],
}; };