### GET /api/saml/redirectUrl

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Gets a SAML initiation URL to redirect your users to.

```APIDOC
## GET /api/saml/redirectUrl

### Description
Gets a SAML initiation URL to redirect your users to.

### Method
GET

### Endpoint
/api/saml/redirectUrl

### Parameters
#### Query Parameters
- **organizationExternalId** (string) - Required - The external ID of the organization.

### Request Example
```json
{
  "organizationExternalId": "my_custom_external_id"
}
```

### Response
#### Success Response (200)
- **redirectUrl** (string) - The URL to redirect users for SAML authentication.

#### Response Example
```json
{
  "redirectUrl": "https://sso.example.com/saml/initiate?id=abc123xyz"
}
```
```

--------------------------------

### GET /api/management/organizations

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Gets a list of organizations.

```APIDOC
## GET /api/management/organizations

### Description
Gets a list of organizations.

### Method
GET

### Endpoint
/api/management/organizations

### Parameters
*No parameters required for this request.*

### Request Example
```json
{} // Empty request body or no parameters needed
```

### Response
#### Success Response (200)
- **organizations** (array) - A list of organizations.

#### Response Example
```json
{
  "organizations": [
    {
      "organizationId": "org_123",
      "name": "Organization Alpha"
    },
    {
      "organizationId": "org_456",
      "name": "Organization Beta"
    }
  ]
}
```
```

--------------------------------

### Create Setup URL with SSOReady TypeScript Client

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Creates a short-lived, self-serve setup URL for customers to configure SAML and SCIM settings. Requires a request object and optional request options.

```typescript
await client.management.setupUrls.createSetupUrl();
```

--------------------------------

### Install SSOReady SDK

Source: https://github.com/ssoready/ssoready-typescript/blob/main/README.md

Installs the ssoready SDK using either npm or yarn package managers.

```bash
npm install --save ssoready
# or
yarn add ssoready
```

--------------------------------

### GET /api/scim/users/{id}

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Gets a SCIM user.

```APIDOC
## GET /api/scim/users/{id}

### Description
Gets a SCIM user.

### Method
GET

### Endpoint
/api/scim/users/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ID of the SCIM user to get.

### Response
#### Success Response (200)
- **userId** (string) - The ID of the SCIM user.
- **userName** (string) - The username of the SCIM user.

#### Response Example
```json
{
  "userId": "user_abc",
  "userName": "john.doe"
}
```
```

--------------------------------

### GET /api/scim/users

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Gets a list of SCIM users in a SCIM directory.

```APIDOC
## GET /api/scim/users

### Description
Gets a list of SCIM users in a SCIM directory.

### Method
GET

### Endpoint
/api/scim/users

### Parameters
#### Query Parameters
- **organizationExternalId** (string) - Required - The external ID of the organization.

### Request Example
```json
{
  "organizationExternalId": "my_custom_external_id"
}
```

### Response
#### Success Response (200)
- **users** (array) - A list of SCIM users.

#### Response Example
```json
{
  "users": [
    {
      "userId": "user_abc",
      "userName": "john.doe"
    },
    {
      "userId": "user_def",
      "userName": "jane.doe"
    }
  ]
}
```
```

--------------------------------

### GET /api/scim/groups

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Gets a list of SCIM groups in a SCIM directory.

```APIDOC
## GET /api/scim/groups

### Description
Gets a list of SCIM groups in a SCIM directory.

### Method
GET

### Endpoint
/api/scim/groups

### Parameters
#### Query Parameters
- **organizationExternalId** (string) - Required - The external ID of the organization.

### Request Example
```json
{
  "organizationExternalId": "my_custom_external_id"
}
```

### Response
#### Success Response (200)
- **groups** (array) - A list of SCIM groups.

#### Response Example
```json
{
  "groups": [
    {
      "groupId": "group_abc",
      "displayName": "Administrators"
    },
    {
      "groupId": "group_def",
      "displayName": "Users"
    }
  ]
}
```
```

--------------------------------

### GET /api/scim/groups/{id}

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Gets a SCIM group in a SCIM directory.

```APIDOC
## GET /api/scim/groups/{id}

### Description
Gets a SCIM group in a SCIM directory.

### Method
GET

### Endpoint
/api/scim/groups/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - ID of the SCIM group to get.

### Response
#### Success Response (200)
- **groupId** (string) - The ID of the SCIM group.
- **displayName** (string) - The display name of the SCIM group.

#### Response Example
```json
{
  "groupId": "group_abc",
  "displayName": "Administrators"
}
```
```

--------------------------------

### Get SAML Redirect URL using TypeScript

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Generates a SAML initiation URL for user redirection. This function is used to obtain a URL that initiates the SAML login process for users. It requires the `organizationExternalId` parameter.

```typescript
await client.saml.getSamlRedirectUrl({
    organizationExternalId: "my_custom_external_id",
});
```

--------------------------------

### Get SCIM User by ID using TypeScript

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Fetches a specific SCIM user from a SCIM directory using its ID. This function retrieves details for a single user. It requires the user's `id` and optionally `requestOptions`.

```typescript
await client.scim.getScimUser("scim_user_...");
```

--------------------------------

### Get SAML Connection by ID - TypeScript

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Retrieves a specific SAML connection by its ID using the SSOReady management API. Accepts the SAML connection ID and optional request options.

```typescript
await client.management.samlConnections.getSamlConnection("id");
```

--------------------------------

### Get Organization by ID - TypeScript

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Retrieves a specific organization by its ID using the SSOReady management API. Accepts the organization ID and optional request options.

```typescript
await client.management.organizations.getOrganization("id");
```

--------------------------------

### Get SCIM Group by ID using TypeScript

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Fetches a specific SCIM group from a SCIM directory using its ID. This function retrieves details for a single group. It requires the group's `id` and optionally `requestOptions`.

```typescript
await client.scim.getScimGroup("scim_group_...");
```

--------------------------------

### Get SCIM Directory using SSOReady TypeScript Client

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Retrieves details of a specific SCIM directory by its ID using the SSOReady TypeScript client. This function requires the unique identifier of the SCIM directory and may accept request options for customizing the API call.

```typescript
await client.management.scimDirectories.getScimDirectory("id");
```

--------------------------------

### Initialize SSOReady Client

Source: https://github.com/ssoready/ssoready-typescript/blob/main/README.md

Creates an instance of the SSOReadyClient, which reads the API key from the SSOREADY_API_KEY environment variable.

```typescript
import { SSOReadyClient } from 'ssoready';

const ssoready = new SSOReadyClient(); // reads api key from env var SSOREADY_API_KEY
```

--------------------------------

### SAML Connections API

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Endpoints for managing SAML connections, including listing, creation, retrieval, and updates.

```APIDOC
## GET /api/saml-connections

### Description
Lists all SAML connections associated with an organization.

### Method
GET

### Endpoint
/api/saml-connections

### Parameters
#### Query Parameters
- **request** (SSOReady.management.SamlConnectionsListSamlConnectionsRequest) - Optional - Filters for listing SAML connections.

#### Request Body
- **requestOptions** (SamlConnections.RequestOptions) - Optional - Options for the request.

### Response
#### Success Response (200)
- **data** (SSOReady.ListSamlConnectionsResponse) - The response object containing a list of SAML connections.

### Response Example
```json
{
  "data": [ ... ] 
}
```
```

```APIDOC
## POST /api/saml-connections

### Description
Creates a new SAML connection for the organization.

### Method
POST

### Endpoint
/api/saml-connections

### Parameters
#### Request Body
- **request** (SSOReady.SamlConnection) - Required - The SAML connection object to create.
- **requestOptions** (SamlConnections.RequestOptions) - Optional - Options for the request.

### Response
#### Success Response (200)
- **data** (SSOReady.CreateSamlConnectionResponse) - The response object containing details of the created SAML connection.

### Response Example
```json
{
  "data": { ... } 
}
```
```

```APIDOC
## GET /api/saml-connections/{id}

### Description
Retrieves a specific SAML connection by its ID.

### Method
GET

### Endpoint
/api/saml-connections/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the SAML connection to retrieve.

#### Request Body
- **requestOptions** (SamlConnections.RequestOptions) - Optional - Options for the request.

### Response
#### Success Response (200)
- **data** (SSOReady.GetSamlConnectionResponse) - The response object containing details of the SAML connection.

### Response Example
```json
{
  "data": { ... } 
}
```
```

```APIDOC
## PUT /api/saml-connections/{id}

### Description
Updates an existing SAML connection.

### Method
PUT

### Endpoint
/api/saml-connections/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the SAML connection to update.

#### Request Body
- **request** (SSOReady.SamlConnection) - Required - The updated SAML connection object.
- **requestOptions** (SamlConnections.RequestOptions) - Optional - Options for the request.

### Response
#### Success Response (200)
- **data** (SSOReady.UpdateSamlConnectionResponse) - The response object containing details of the updated SAML connection.

### Response Example
```json
{
  "data": { ... } 
}
```
```

--------------------------------

### Create Organization - TypeScript

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Creates a new organization using the SSOReady management API. Requires organization details as a request parameter and optional request options.

```typescript
await client.management.organizations.createOrganization({});
```

--------------------------------

### Create SCIM Directory using SSOReady TypeScript Client

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Creates a new SCIM directory within an organization using the SSOReady TypeScript client. This function requires a request object that defines the properties of the new SCIM directory and may accept additional request options.

```typescript
await client.management.scimDirectories.createScimDirectory({});
```

--------------------------------

### SCIM Directories API

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

API endpoints for managing SCIM directories, including listing, creating, retrieving, updating, and rotating bearer tokens.

```APIDOC
## GET /api/ssoready/management/scimDirectories

### Description
Gets a list of SCIM directories in an organization.

### Method
GET

### Endpoint
/api/ssoready/management/scimDirectories

### Parameters
#### Query Parameters
- **request** (SSOReady.management.ScimDirectoriesListScimDirectoriesRequest) - Optional - Parameters for listing SCIM directories.
- **requestOptions** (ScimDirectories.RequestOptions) - Optional - Additional options for the request.

### Response
#### Success Response (200)
- **data** (SSOReady.ListScimDirectoriesResponse) - A list of SCIM directories.

#### Response Example
```json
{
  "data": [ ... ]
}
```
```

```APIDOC
## POST /api/ssoready/management/scimDirectories

### Description
Creates a SCIM directory.

### Method
POST

### Endpoint
/api/ssoready/management/scimDirectories

### Parameters
#### Request Body
- **request** (SSOReady.ScimDirectory) - Required - The SCIM directory object to create.
- **requestOptions** (ScimDirectories.RequestOptions) - Optional - Additional options for the request.

### Request Example
```json
{
  "request": { ... },
  "requestOptions": { ... }
}
```

### Response
#### Success Response (200)
- **data** (SSOReady.CreateScimDirectoryResponse) - Details of the created SCIM directory.

#### Response Example
```json
{
  "data": { ... }
}
```
```

```APIDOC
## GET /api/ssoready/management/scimDirectories/{id}

### Description
Gets a SCIM directory.

### Method
GET

### Endpoint
/api/ssoready/management/scimDirectories/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the SCIM directory.

#### Query Parameters
- **requestOptions** (ScimDirectories.RequestOptions) - Optional - Additional options for the request.

### Response
#### Success Response (200)
- **data** (SSOReady.GetScimDirectoryResponse) - Details of the SCIM directory.

#### Response Example
```json
{
  "data": { ... }
}
```
```

```APIDOC
## POST /api/ssoready/management/scimDirectories/{id}

### Description
Updates a SCIM directory.

### Method
POST

### Endpoint
/api/ssoready/management/scimDirectories/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the SCIM directory to update.

#### Request Body
- **request** (SSOReady.ScimDirectory) - Required - The updated SCIM directory object.
- **requestOptions** (ScimDirectories.RequestOptions) - Optional - Additional options for the request.

### Request Example
```json
{
  "request": { ... },
  "requestOptions": { ... }
}
```

### Response
#### Success Response (200)
- **data** (SSOReady.UpdateScimDirectoryResponse) - Details of the updated SCIM directory.

#### Response Example
```json
{
  "data": { ... }
}
```
```

```APIDOC
## POST /api/ssoready/management/scimDirectories/{id}/rotate-bearer-token

### Description
Rotates a SCIM directory's bearer token. This invalidates the previous token and generates a new one.

### Method
POST

### Endpoint
/api/ssoready/management/scimDirectories/{id}/rotate-bearer-token

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the SCIM directory whose bearer token to rotate.

#### Query Parameters
- **requestOptions** (ScimDirectories.RequestOptions) - Optional - Additional options for the request.

### Response
#### Success Response (200)
- **data** (SSOReady.RotateScimDirectoryBearerTokenResponse) - Details of the rotated bearer token.

#### Response Example
```json
{
  "data": { ... }
}
```
```

--------------------------------

### List SAML Connections - TypeScript

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Lists all SAML connections within an organization using the SSOReady management API. Accepts optional request parameters for filtering and pagination.

```typescript
await client.management.samlConnections.listSamlConnections();
```

--------------------------------

### Organizations API

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Endpoints for managing organizations, including creation, retrieval, and updates.

```APIDOC
## POST /api/organizations

### Description
Creates an organization.

### Method
POST

### Endpoint
/api/organizations

### Parameters
#### Request Body
- **request** (SSOReady.Organization) - Required - The organization object to create.
- **requestOptions** (Organizations.RequestOptions) - Optional - Options for the request.

### Request Example
```json
{
  "organization": { ... } 
}
```

### Response
#### Success Response (200)
- **data** (SSOReady.CreateOrganizationResponse) - The response object containing details of the created organization.

### Response Example
```json
{
  "data": { ... } 
}
```
```

```APIDOC
## GET /api/organizations/{id}

### Description
Gets a specific organization by its ID.

### Method
GET

### Endpoint
/api/organizations/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the organization to retrieve.

#### Request Body
- **requestOptions** (Organizations.RequestOptions) - Optional - Options for the request.

### Response
#### Success Response (200)
- **data** (SSOReady.GetOrganizationResponse) - The response object containing details of the organization.

### Response Example
```json
{
  "data": { ... } 
}
```
```

```APIDOC
## PUT /api/organizations/{id}

### Description
Updates an existing organization.

### Method
PUT

### Endpoint
/api/organizations/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the organization to update.

#### Request Body
- **request** (SSOReady.Organization) - Required - The updated organization object.
- **requestOptions** (Organizations.RequestOptions) - Optional - Options for the request.

### Response
#### Success Response (200)
- **data** (SSOReady.UpdateOrganizationResponse) - The response object containing details of the updated organization.

### Response Example
```json
{
  "data": { ... } 
}
```
```

--------------------------------

### Create SAML Connection - TypeScript

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Creates a new SAML connection using the SSOReady management API. Requires SAML connection details as a request parameter and optional request options.

```typescript
await client.management.samlConnections.createSamlConnection({});
```

--------------------------------

### Initiate SAML Login

Source: https://github.com/ssoready/ssoready-typescript/blob/main/README.md

Generates a SAML redirect URL to initiate the login process by redirecting users to their corporate identity provider. This is used for 'Sign in with SSO' buttons.

```typescript
// this is how you implement a "Sign in with SSO" button
const { redirectUrl } = await ssoready.saml.getSamlRedirectUrl({
  // the ID of the organization/workspace/team (whatever you call it)
  // you want to log the user into
  organizationExternalId: "..."
});

// redirect the user to `redirectUrl`...
```

--------------------------------

### List SCIM Users using TypeScript

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Retrieves a list of SCIM users from a SCIM directory. This function allows fetching all users within a specified organization. It requires the `organizationExternalId` parameter.

```typescript
await client.scim.listScimUsers({
    organizationExternalId: "my_custom_external_id",
});
```

--------------------------------

### List SCIM Users

Source: https://github.com/ssoready/ssoready-typescript/blob/main/README.md

Fetches a list of SCIM users for a given organization, typically used to synchronize employee data. It returns user details and a pagination token for subsequent requests.

```typescript
const { scimUsers, nextPageToken } = await ssoready.scim.listScimUsers({
  organizationExternalId: "my_custom_external_id"
});

// create users from each scimUser
for (const { email, deleted, attributes } of scimUsers) {
  // ...
}
```

--------------------------------

### POST /api/saml/redeemAccessCode

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Exchanges a SAML access code for details about your user's SAML login details.

```APIDOC
## POST /api/saml/redeemAccessCode

### Description
Exchanges a SAML access code for details about your user's SAML login details.

### Method
POST

### Endpoint
/api/saml/redeemAccessCode

### Parameters
#### Request Body
- **samlAccessCode** (string) - Required - The SAML access code.

### Request Example
```json
{
  "samlAccessCode": "saml_access_code_..."
}
```

### Response
#### Success Response (200)
- **user** (object) - Details about the user's SAML login.
- **organization** (object) - Details about the organization.

#### Response Example
```json
{
  "user": {
    "userId": "user_123",
    "email": "user@example.com"
  },
  "organization": {
    "organizationId": "org_456",
    "name": "Example Org"
  }
}
```
```

--------------------------------

### List SCIM Directories using SSOReady TypeScript Client

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Retrieves a list of SCIM directories configured within an organization using the SSOReady TypeScript client. This operation may accept parameters for filtering or pagination and returns a response object containing the list of SCIM directories.

```typescript
await client.management.scimDirectories.listScimDirectories();
```

--------------------------------

### List SCIM Groups using TypeScript

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Retrieves a list of SCIM groups from a SCIM directory. This function allows fetching all groups within a specified organization. It requires the `organizationExternalId` parameter.

```typescript
await client.scim.listScimGroups({
    organizationExternalId: "my_custom_external_id",
});
```

--------------------------------

### List Organizations using TypeScript

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Retrieves a list of all organizations. This function can be used to fetch organization data, with optional parameters for customization.

```typescript
await client.management.organizations.listOrganizations();
```

--------------------------------

### Redeem SAML Access Code using TypeScript

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Exchanges a SAML access code for user login details. This function takes a SAML access code as input and returns SAML login information. It requires the `samlAccessCode` parameter.

```typescript
await client.saml.redeemSamlAccessCode({
    samlAccessCode: "saml_access_code_...",
});
```

--------------------------------

### Handle SAML Callback

Source: https://github.com/ssoready/ssoready-typescript/blob/main/README.md

Redeems a SAML access code received via a POST request to a callback endpoint, typically '/ssoready-callback'. This is used to log the user in after authentication.

```typescript
// this goes in your handler for POST /ssoready-callback
const { email, organizationExternalId } = await ssoready.saml.redeemSamlAccessCode({
    samlAccessCode: "saml_access_code_..."
});

// log the user in as `email` inside `organizationExternalId`...
```

--------------------------------

### Update SCIM Directory using SSOReady TypeScript Client

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Updates an existing SCIM directory identified by its ID using the SSOReady TypeScript client. The update operation accepts the directory ID and a request body containing the modifications, along with optional request options.

```typescript
await client.management.scimDirectories.updateScimDirectory("id", {});
```

--------------------------------

### UPDATE SAML Connection

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Updates an existing SAML connection. This endpoint allows modification of SAML connection settings.

```APIDOC
## POST /api/ssoready/management/samlConnections/{id}

### Description
Updates an existing SAML connection. This endpoint allows modification of SAML connection settings.

### Method
POST

### Endpoint
/api/ssoready/management/samlConnections/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the SAML connection to update.

#### Request Body
- **request** (SSOReady.SamlConnection) - Required - The updated SAML connection object.
- **requestOptions** (SamlConnections.RequestOptions) - Optional - Additional options for the request.

### Request Example
```json
{
  "request": { ... },
  "requestOptions": { ... }
}
```

### Response
#### Success Response (200)
- **data** (SSOReady.SamlConnection) - The updated SAML connection details.

#### Response Example
```json
{
  "data": { ... }
}
```
```

--------------------------------

### Rotate SCIM Directory Bearer Token using SSOReady TypeScript Client

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Rotates the bearer token for a specific SCIM directory using the SSOReady TypeScript client. This action invalidates the previous token and generates a new one, which is essential for maintaining SCIM synchronization. The operation requires the directory ID and may include request options.

```typescript
await client.management.scimDirectories.rotateScimDirectoryBearerToken("id");
```

--------------------------------

### Update Organization by ID - TypeScript

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Updates an existing organization identified by its ID using the SSOReady management API. Requires the organization ID, updated organization data, and optional request options.

```typescript
await client.management.organizations.updateOrganization("id", {});
```

--------------------------------

### Update SAML Connection by ID - TypeScript

Source: https://github.com/ssoready/ssoready-typescript/blob/main/reference.md

Updates an existing SAML connection identified by its ID using the SSOReady management API. Requires the SAML connection ID, updated connection data, and optional request options.

```typescript
await client.management.samlConnections.updateSamlConnection("id", {});
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.