Wristband

https://docs.wristband.dev/
Admin
Wristband is a multi-tenant authentication platform that provides secure, granular access control...
Tokens:2,414,847
Snippets:9,266
Trust Score:6.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### OAuth2 Client Configuration Example

Source: https://docs.wristband.dev/reference/patchidentityproviderv1

Provides an example of OAuth2 configuration, specifying the client ID for authentication. This is a basic setup for integrating with an OAuth2 provider.

```json
{
  "type": "OAUTH2",
  "clientId": "1234567890-abc123def456.apps.googleusercontent.com"
}
```

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

### Full Identity Provider Resource Example

Source: https://docs.wristband.dev/reference/patchidentityproviderv1

A complete example of an identity provider resource, showing its ID, owner information, type, name, status, and protocol configuration. This example demonstrates a 'GOOGLE' type IDP with 'ENABLED' status.

```JSON
{
  "id": "u9k33onh6nbsjggayhubbef5te",
  "ownerType": "APPLICATION",
  "ownerId": "1sor7zaca5bzrmic3w7h2okogw",
  "type": "GOOGLE",
  "name": "google",
  "displayName": "Google",
  "isExternal": true,
  "status": "ENABLED",
  "protocol": {
    "type": "OAUTH2",
    "clientId": "1234567890-abc123def456.apps.googleusercontent.com",
    "clientSecret": "6ae50f72-e7e1-4a9f-a4f4-289ee3ba9bdd",
    "scopes": [
      "some:scope"
    ],
    "redirectUrl": "https://app.com/redirect",
    "redirectDomainName": "app.com"
  }
}
```

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

### Token Acquisition Examples

Source: https://docs.wristband.dev/reference/tokenv1

Examples demonstrating how to obtain an ID token and an access token for machine-to-machine clients.

```APIDOC
## Token Acquisition Examples

### ID Token Example

This example shows the structure of an ID token obtained from the API.

```json
{
  "id_token": "eyJraWQiOiJqb3pubHp5ejRiZmg1b3l1ZGFxbmpppHYzbSIsInR5cCI6ImlkK0pXVCIsImFsZyI6IlJTMjU2In0.eyJhdF9oYXNoIjoicl82TklWQm9zSi0zOWQ3OGZTWlpppSIsInN1YiI6Im0zejR6NzQ1eG5oYWRhZjV6c2trZ2h1ZmptIiwiaWRwX25hbWUiOiJBcGl0b3BpYSIsImFtciI6WyJwd2QiXSwiaXNzIjoiaHR0cHM6XC9cL2Rhc2hib2FyZC1hcGl0b3BpYS5kZXYuYXBpdG9waWEuaW8iLCJub25jZSI6InVXV2Q2VC00NERBbmc4Wi1DcjVGdk1OWWNhd2NwSFRKdHNpdDFMbXJEWmciLCJhdWQiOiJuZnFzZDVxczRqZmx6a21oZTVhbWJraWVreSIsInRudF9pZCI6InFueTQ0dGdpN3ZmeDNjcG9tcXNjcmIyamN1IiwiYXV0aF90aW1lIjoxNjU5MzEwMjMwLCJleHAiOjE2NTkzMTIzMjcsImFwcF9pZCI6Im03azU1b25oNm5ic2pnZ2F5aHViYmVmNGVxIiwiaWF0IjoxNjU5MzEwNTI3LCJqdGkiOiJzc2JlMjdqemxuYmc1aXRmbG9saWMybHlnaSJ9.keMQpi25wcivhubJYtMSCiQkN2lXSRqXAw7FJB09naVS8XKHgELzLvM5cmzrzCcNSCRXk0LLdPJ1E5ATRVIkzJ6dLNR8RubF5Tijly6cp2R_9x2ziA94VyQDgO95BPg6HI6Oji9l3ruNYNwrJ-FAjZ1ZD8a_ZbunGo4HT2bXKVqFtEBM28Yf1u47wQsm4CxEwAa558X4Bq-bvkX8nccjlSEqq1TQLfP8hm0xMVH5mjwfBmbKkxoKPVxVKQKOx8RLX4xV4W0-uWl1dw3frquKLdzXGxGW0KYLNrQl_rT6V23DaZFuAIaLRJpppptqLNei2IoHciRR1HEUBwe3VzNx4A"
}
```

### Machine to Machine Client Access Token Example

This example shows the structure of an access token obtained for machine-to-machine clients.

```json
{
  "access_token": "eyJraWQiOiJqb3pubHp5ejRiZmg1b3l1ZGFxbmRpppYzbSIsInR5cCI6ImF0K0pXVCIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiJtM3o0ejc0NXhuaGFkYWY1enNra2pppWZqbSIsImlkcF9uYW1lIjoiQXBpdG9waWEiLCJ2YW5fZG9tIjoiZGFzaGJvYXJkLWFwaXRvcGlhLmRldi5hcGl0b3BpYS5pbyIsImFtciI6WyJwd2QiXSwiaXNzIjoiaHR0cHM6XC9cL2Rhc2hib2FyZC1hcGl0b3BpYS5kZXYuYXBpdG9waWEuaW8iLCJjbGllbnRfaWQiOiJuZnFzZDVxczRqZmx6a21oZTVhbWJraWVreSIsInRudF9pZCI6InFueTQ0dGdpN3ZmeDNjcG9tcXNjcmIyamN1Iiwic2NvcGUiOiJvcGVuaWQgb2ZmbGluZV9hY2Nlc3MiLCJhdXRoX3RpbWUiOjE2NTkzMTAyMzAsInN1Yl9raW5kIjoidXNlciIsImV4cCI6MTY1OTMxMjMyNywiYXBwX2lkIjoibTdrNTVvbmg2bmJzamdnYXlodWJiZWY0ZXEiLCJpYXQiOjE2NTkzMTA1MjcsImp0aSI6IjV0dXh1YWVjcXJiaDdvMm8ybmV4azZ1YTZhIn0.HfEieCvd0vAUBbHGenvQCmgzbOBdEitI8NeLsVViORqKwrRU8d8bBc3FgR2H5v4PL9wv_NlgfIA2AQppnRj7qx4Hd5gM1nHKDyAl3TnQQxxNKRSAoo3e3XCau9zeEyHY89vxIi1vX1mQEOX0rkpakabtgo7VQ0eymHbVYqt0frVPLJvc87P9kjt_okiS9QZcrGwZf4MyXs-bT0M55m-YGC6kiem1Cy3OMkK-RFq_xiUhVcC7pg9Gn6lFJQ1MzdZIjIrsFHSJnmN6opppY6NdkQl0YkxkVWrBugKHXj6Jl0dign9DTctAXJ3iQS7spZshle-iAqogS_ET1IM0vi03jQ",
  "token_type": "Bearer",
  "expires_in": 1800,
  "scope": "openid offline_access"
}
```
```

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

### Google IDP Example

Source: https://docs.wristband.dev/reference/patchidentityproviderv1

Example configuration for a Google identity provider.

```APIDOC
## Google IDP Example

### Description
An example demonstrating the configuration for a Google identity provider, including status and protocol details.

### Method
N/A (Example)

### Endpoint
N/A

### Parameters
#### Request Body
- **status** (string) - The status of the IDP (e.g., ENABLED).
- **protocol** (object) - Protocol-specific configuration.
  - **type** (string) - The protocol type (e.g., OAUTH2).
  - **clientId** (string) - The OAuth2 client ID.
  - **clientSecret** (string) - The OAuth2 client secret.
  - **scopes** (array[string]) - List of OAuth2 scopes.

### Request Example
```json
{
  "status": "ENABLED",
  "protocol": {
    "type": "OAUTH2",
    "clientId": "2c075bd4-5ac9-4e85-a197-d5e3f53b5a77",
    "clientSecret": "secretValue",
    "scopes": []
  }
}
```

### Response
#### Success Response (200)
(Same structure as Request Example)

#### Response Example
```json
{
  "status": "ENABLED",
  "protocol": {
    "type": "OAUTH2",
    "clientId": "2c075bd4-5ac9-4e85-a197-d5e3f53b5a77",
    "clientSecret": "secretValue",
    "scopes": []
  }
}
```
```

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

### OAUTH2 Identity Provider Configuration Example

Source: https://docs.wristband.dev/reference/getidentityproviderv1

Provides an example configuration for an OAUTH2 Identity Provider (IDP). This includes essential details like `clientId`, `clientSecret`, `scopes`, `redirectUrl`, and `redirectDomainName`, necessary for authenticating users via OAuth2 flows.

```json
{
  "type": "OAUTH2",
  "clientId": "1234567890-abc123def456.apps.googleusercontent.com",
  "clientSecret": "6ae50f72-e7e1-4a9f-a4f4-289ee3ba9bdd",
  "scopes": [
    "some:scope"
  ],
  "redirectUrl": "https://app.com/redirect",
  "redirectDomainName": "app.com"
}
```

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

### Wristband IDP Example

Source: https://docs.wristband.dev/reference/patchidentityproviderv1

Example configuration for a Wristband identity provider.

```APIDOC
## Wristband IDP Example

### Description
An example demonstrating the configuration for a Wristband identity provider, specifying login identifiers and factors.

### Method
N/A (Example)

### Endpoint
N/A

### Parameters
#### Request Body
- **status** (string) - The status of the IDP (e.g., ENABLED).
- **loginIdentifiers** (array[string]) - The identifiers used for login (e.g., EMAIL).
- **loginFactors** (array[string]) - The factors used for login (e.g., PASSWORD).

### Request Example
```json
{
  "status": "ENABLED",
  "loginIdentifiers": [
    "EMAIL"
  ],
  "loginFactors": [
    "PASSWORD"
  ]
}
```

### Response
#### Success Response (200)
(Same structure as Request Example)

#### Response Example
```json
{
  "status": "ENABLED",
  "loginIdentifiers": [
    "EMAIL"
  ],
  "loginFactors": [
    "PASSWORD"
  ]
}
```
```

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

### Error Examples

Source: https://docs.wristband.dev/reference/queryapplicationcustomdomainsv1

Provides examples of common error responses, including invalid requests and constraint violations.

```APIDOC
## Error Examples

### Description
This section provides concrete examples of error responses that can be returned by the API.

### Invalid Request Error Example

This example shows a basic error response for an invalid request.

#### Response Example (400)

```json
{
  "type": "base_error",
  "code": "invalid_request",
  "message": "The request was invalid",
  "ticket": "11t7n71hi5e6t"
}
```

### Constraint Violations Error Example

This example demonstrates an error response when request body constraints are violated.

#### Response Example (400)

```json
{
  "type": "constraint_violations_error",
  "code": "message_body_constraint_violations",
  "message": "The message body contained invalid fields",
  "ticket": "11t7n71hi5e6t",
  "violations": {
    "field1": {
      "code": "too_long",
      "constraintAttributes": {
        "maxLength": 10
      }
    },
    "field2": {
      "code": "not_null"
    }
  }
}
```
```

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

### Example Side Panel Configuration (JSON)

Source: https://docs.wristband.dev/reference/createpagebrandingv1

An example JSON object demonstrating a configuration for a side panel. This example shows a right-aligned image side panel that occupies 45.5% of the screen width and appears at a breakpoint of 950 pixels.

```json
{
  "layout": "LEFT",
  "type": "IMAGE",
  "widthPercent": 45.5,
  "breakpointPixels": 950,
  "imageUrl": "https://example.com/image.png",
  "iframeSrcUrl": null
}
```

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

### Authentication Factors API - Examples

Source: https://docs.wristband.dev/reference/getauthfactorv1

This section provides examples of different authentication factor objects.

```APIDOC
## Authentication Factors API

### Description
This API provides examples for TOTP and Recovery Code authentication factors.

### Method
GET (implied by examples)

### Endpoint
`/some/endpoint` (inferred from context)

### Parameters
None specified for examples.

### Request Example
None provided for examples.

### Response
#### Success Response (200)
Examples show the structure of TOTP and Recovery Code auth factors.

#### Response Example
**TOTP Auth Factor Example:**
```json
{
  "id": "a4jzydksmrf3jnu5yfcwpl4a4a",
  "userId": "d7aml4q5lza3fdi2gavzdliouy",
  "type": "TOTP",
  "qrCode": "data:image/png;base64,iVBORw0KGgoAdajkjNSUhEUgAAAV4AA",
  "secret": "ENNAGAAFS3EYRB422HNAKAKY3XDUORMSRFABLED",
  "uri": "otpauth://totp/App:user@example.com<tenant>?secret=ENNAGAAFS3EYRB422HNAKAKY3XDUORMSRFABLED&issuer=App",
  "status": "ACTIVE",
  "metadata": {
    "lastModifiedTime": "2021-06-13T19:49:31.686Z",
    "creationTime": "2021-06-13T19:49:31.686Z"
  }
}
```

**Recovery Code Auth Factor Example:**
```json
{
  "id": "a4jzydksmrf3jnu5yfcwpl4a4a",
  "userId": "d7aml4q5lza3fdi2gavzdliouy",
  "type": "RECOVERY_CODE",
  "status": "ACTIVE",
  "metadata": {
    "lastModifiedTime": "2021-06-13T19:49:31.686Z",
    "creationTime": "2021-06-13T19:49:31.686Z"
  }
}
```
```

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

### Example Identity Provider Resource Representation

Source: https://docs.wristband.dev/reference/getidentityproviderv1

Illustrates a complete example of an Identity Provider (IDP) resource, including its ID, owner details, type, name, and protocol-specific configurations for both OAUTH2. This representation is typical when fetching or creating IDP resources via the API.

```json
{
  "id": "u9k33onh6nbsjggayhubbef5te",
  "ownerType": "APPLICATION",
  "ownerId": "1sor7zaca5bzrmic3w7h2okogw",
  "type": "GOOGLE",
  "name": "google",
  "displayName": "Google",
  "isExternal": true,
  "status": "ENABLED",
  "protocol": {
    "type": "OAUTH2",
    "clientId": "1234567890-abc123def456.apps.googleusercontent.com",
    "clientSecret": "6ae50f72-e7e1-4a9f-a4f4-289ee3ba9bdd",
    "redirectUrl": "https://app.com/redirect",
    "redirectDomainName": "app.com"
  },
  "metadata": {
  }
}
```

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

### Authenticate Get User API with Postman

Source: https://docs.wristband.dev/docs/getting-access-tokens-to-test-apis

This guide explains how to configure Postman to authenticate requests to the Wristband Get User API. It details the steps for selecting 'Bearer Token' as the authorization type and pasting the access token into the designated field within the Authorization tab. This setup ensures your requests are properly authenticated.

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

### User Provisioning Response Examples (JSON)

Source: https://docs.wristband.dev/reference/provisionexternalidpuseronsignupv1

Illustrates various possible response structures for user provisioning operations. These responses indicate the status of user signup and activation, including details like user IDs, tenant IDs, and request identifiers for verification or activation processes.

```json
{
  "result": "SIGNUP_COMPLETED",
  "userId": "wpl4a4aa4jzydksmrf3jnu5yfc",
  "tenantId": "4ydnskw575eqnonwgygvqjlbue",
  "redirectUrl": "http://cust1-app-tenant1.us.wristband.dev/api/v1/signup/create-auth-session?auth_session_code=eyJraWQiOiJlbjBPcW9HOU8zVzUxWno5TE1mN2RjMzlzaDJwYi13SDJLNWF4ZzVuUUc4IiwidHlwIjoic2MrSldUIiwiYWxnIjoiSFMyNTYifQ.eyJwYXJ0aXRpb24iOjEsImV4cCI6MTY1OTU2NjMxMiwianRpIjoiejdrNmU0YndxdmZleGt6YjZjcmJuY2ludG0ifQ.I3W1hbT0YqTG9ZFOTP4lToB_7Z1q30P8jsRxJ0UkSew"
}
```

```json
{
  "result": "SIGNUP_COMPLETED_WITH_EMAIL_VERIFICATION",
  "userId": "wpl4a4aa4jzydksmrf3jnu5yfc",
  "tenantId": "4ydnskw575eqnonwgygvqjlbue",
  "emailVerificationRequestId": "3jnu5yfcwpl4a4aa4jzydksmrf",
  "redirectUrl": "http://cust1-app-tenant1.us.wristband.dev/api/v1/signup/create-auth-session?auth_session_code=eyJraWQiOiJlbjBPcW9HOU8zVzUxWno5TE1mN2RjMzlzaDJwYi13SDJLNWF4ZzVuUUc4IiwidHlwIjoic2MrSldUIiwiYWxnIjoiSFMyNTYifQ.eyJwYXJ0aXRpb24iOjEsImV4cCI6MTY1OTU2NjMxMiwianRpIjoiejdrNmU0YndxdmZleGt6YjZjcmJuY2ludG0ifQ.I3W1hbT0YqTG9ZFOTP4lToB_7Z1q30P8jsRxJ0UkSew"
}
```

```json
{
  "result": "SIGNUP_COMPLETED_WITH_USER_ACTIVATION",
  "userId": "wpl4a4aa4jzydksmrf3jnu5yfc",
  "tenantId": "4ydnskw575eqnonwgygvqjlbue",
  "userActivationRequestId": "3jnu5yfcwpl4a4aa4jzydksmrf"
}
```

```json
{
  "result": "ACTIVATION_EMAIL_RESENT",
  "userId": "wpl4a4aa4jzydksmrf3jnu5yfc",
  "tenantId": "4ydnskw575eqnonwgygvqjlbue",
  "userActivationRequestId": "3jnu5yfcwpl4a4aa4jzydksmrf"
}
```

```json
{
  "result": "ACTIVATION_OTP_EMAIL_SENT",
  "userId": "wpl4a4aa4jzydksmrf3jnu5yfc"
}
```

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

### Get User API - Authorization Example

Source: https://docs.wristband.dev/reference/api-authorization

This section details the authorization requirements for the Get User API, explaining the role of permissions and boundaries.

```APIDOC
## GET /reference/getuserv1

### Description
Retrieves user information based on the authenticated subject's permissions and applied boundaries.

### Method
GET

### Endpoint
`/reference/getuserv1`

### Parameters
#### Query Parameters
- **userId** (string) - Required - The ID of the user to retrieve.

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **user** (object) - The retrieved user object.
  - **id** (string) - The user's unique identifier.
  - **name** (string) - The user's name.
  - **tenantId** (string) - The ID of the tenant the user belongs to.

#### Response Example
```json
{
  "user": {
    "id": "user_abc123",
    "name": "Alice Smith",
    "tenantId": "tenant_xyz789"
  }
}
```

### Required Permissions
To call this API, the authenticated subject must have the `user:read` permission. Calls made without this permission will return a 403 Forbidden response.

### Permission Boundaries
The `user:read` permission supports the following boundaries, which define the scope of access:

*   **Application**: Allows access to all users within the same application.
*   **Tenant**: Allows access to all users within the same tenant.
*   **Tenant Inclusion List**: Allows access to users within specific tenants listed.
*   **Tenant Exclusion List**: Allows access to users except those within specific tenants listed.
*   **Self**: Allows access only to the authenticated subject's own user information.
```

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

### Get User API with Field Filtering

Source: https://docs.wristband.dev/reference/field-level-filtering

Example of how to use the `fields` query parameter to retrieve specific fields from the Get User API.

```APIDOC
## GET /api/v1/users/{userId}

### Description
Retrieves user information, allowing for field-level filtering.

### Method
GET

### Endpoint
`/api/v1/users/{userId}`

### Parameters
#### Query Parameters
- **fields** (string) - Optional - A comma-separated list of fields to include in the response. Use `*` to include all fields, or leave blank to exclude all fields.

### Request Example
```http
GET https://yourapp-yourorg.us.wristband.dev/api/v1/users/123?fields=id,givenName,lastName
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the user.
- **givenName** (string) - The first name of the user.
- **familyName** (string) - The last name of the user.

#### Response Example
```json
{
  "id": "x63nnomvwrgqhgd2ofpdt3uk5e",
  "givenName": "Bob",
  "familyName": "Smith"
}
```
```

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

### Full Identity Provider Resource Example

Source: https://docs.wristband.dev/reference/getidentityproviderv1

A complete example of an Identity Provider resource, demonstrating the structure for both Google OAuth2 integration and metadata.

```json
{
  "id": "u9k33onh6nbsjggayhubbef5te",
  "ownerType": "APPLICATION",
  "ownerId": "1sor7zaca5bzrmic3w7h2okogw",
  "type": "GOOGLE",
  "name": "google",
  "displayName": "Google",
  "isExternal": true,
  "status": "ENABLED",
  "protocol": {
    "type": "OAUTH2",
    "clientId": "1234567890-abc123def456.apps.googleusercontent.com",
    "clientSecret": "6ae50f72-e7e1-4a9f-a4f4-289ee3ba9bdd",
    "redirectUrl": "https://app.com/redirect",
    "redirectDomainName": "app.com"
  },
  "metadata": {
    "version": "1.0",
    "lastModifiedTime": "2021-06-13T19:49:31.686Z",
    "creationTime": "2021-06-13T19:49:31.686Z"
  }
}
```

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

### Get Identity Provider API with Nested Field Filtering

Source: https://docs.wristband.dev/reference/field-level-filtering

Example of how to use path expressions in the `fields` query parameter to retrieve nested fields from the Get Identity Provider API.

```APIDOC
## GET /api/v1/identity-providers/{identityProviderId}

### Description
Retrieves identity provider information, allowing for filtering of nested fields.

### Method
GET

### Endpoint
`/api/v1/identity-providers/{identityProviderId}`

### Parameters
#### Query Parameters
- **fields** (string) - Optional - A comma-separated list of fields to include in the response. Use path expressions for nested fields (e.g., `protocol.type`). Use `*` to include all fields, or leave blank to exclude all fields.

### Request Example
```http
GET https://yourapp-yourcompany.us.wristband.dev/api/v1/identity-providers/123?fields=protocol.type
```

### Response
#### Success Response (200)
- **protocol.type** (string) - The type of the protocol used by the identity provider.

#### Response Example
```json
{
  "protocol": {
    "type": "OAUTH2"
  }
}
```
```

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

### Create Application

Source: https://docs.wristband.dev/reference/createtenantv1

Creates a new application with specified details, including domain, tenant, and authentication configurations.

```APIDOC
## POST /websites/wristband_dev/applications

### Description
Creates a new application.

### Method
POST

### Endpoint
`/websites/wristband_dev/applications`

### Parameters
#### Request Body
- **domainName** (string) - Required - The domain name associated to the application. Must be unique and can only contain alphanumeric characters.
- **displayName** (string) - Required - A friendly name for the application.
- **isMultiTenant** (boolean) - Required - Boolean indicating whether this application allows support for multiple tenants.
- **environmentType** (string) - Required - The application's environment type (DEVELOPMENT or PRODUCTION).
- **loginUrl** (string) - Required - The application's login URL. Use `{tenant_domain}` token for multi-tenant applications.
- **tenantClassifier** (string) - Optional - The default classifier for the application's tenants. Defaults to TENANT.

### Request Example
```json
{
  "domainName": "application",
  "displayName": "My Application",
  "isMultiTenant": true,
  "environmentType": "DEVELOPMENT",
  "loginUrl": "http://app.example.com/auth/login",
  "tenantClassifier": "ORGANIZATION"
}
```

### Response
#### Success Response (201 Created)
- **id** (string) - The unique identifier of the newly created application.
- **vanityDomain** (string) - The vanity domain assigned to the new application.
- **resolvedVanityDomain** (string) - The resolved vanity domain.
- **domainName** (string) - The domain name used for the application.
- **displayName** (string) - The display name of the application.
- **isMultiTenant** (boolean) - Indicates multi-tenancy support.
- **tenantClassifier** (string) - The tenant classifier.
- **environmentType** (string) - The environment type.
- **loginUrl** (string) - The login URL.
- **loginUrlContainsTenantDomainToken** (boolean) - Indicates if the login URL contains a tenant domain token.
- **loginUrlTenantDomainSuffix** (string) - The tenant domain suffix if applicable.

#### Response Example
```json
{
  "id": "newly_created_app_id",
  "vanityDomain": "application.us.wristband.dev",
  "resolvedVanityDomain": "auth.app.com",
  "domainName": "application",
  "displayName": "My Application",
  "isMultiTenant": true,
  "tenantClassifier": "ORGANIZATION",
  "environmentType": "DEVELOPMENT",
  "loginUrl": "http://app.example.com/auth/login",
  "loginUrlContainsTenantDomainToken": true,
  "loginUrlTenantDomainSuffix": "app.example.com"
}
```
```

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

### List of Override Toggles Example

Source: https://docs.wristband.dev/reference/querytenantauthsessionpolicyoverridetogglesv1

An example of a response containing a list of override toggles. It includes pagination details like total results, start index, and items per page, followed by an array of override toggle objects.

```json
{
  "totalResults": 200,
  "startIndex": 1,
  "itemsPerPage": 10,
  "items": [
    {
      "id": "qny44tgi7vfx3cpomqscrb2jcu",
      "ownerType": "TENANT",
      "ownerId": "yrqdfjhvn5hzph45opnjxgs5fy"
    }
  ]
}
```

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

### Example Resource with Version Metadata

Source: https://docs.wristband.dev/reference/patchidentityproviderv1

An example of a 'WRISTBAND' resource, showcasing its ID, owner details, type, name, display name, status, and associated version metadata.

```json
{
  "id": "u9k33onh6nbsjggayhubbef5te",
  "ownerType": "APPLICATION",
  "ownerId": "1sor7zaca5bzrmic3w7h2okogw",
  "type": "WRISTBAND",
  "name": "wristband",
  "displayName": "Wristband",
  "isExternal": false,
  "status": "ENABLED",
  "metadata": {
    "version": "1.0",
    "lastModifiedTime": "2021-06-13T19:49:31.686Z",
    "creationTime": "2021-06-13T19:49:31.686Z"
  }
}
```

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

### Apple Identity Provider Configuration Example

Source: https://docs.wristband.dev/reference/patchidentityproviderv1

A basic configuration example for an Apple identity provider. This snippet shows the initial structure for setting up Apple as an external IdP, typically requiring specific client credentials and redirect configurations for authentication.

```json
{
  "id": "u9k33onh6nbsjggayhubbef5te",
  "ownerType": "APPLICATION",
  "ownerId": "1sor7zaca5bzrmic3w7h2okogw",
  "type": "APPLE",
}
```

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

### GET /websites/wristband_dev

Source: https://docs.wristband.dev/reference/getrolesassignedtoclientv1

Retrieves a paginated list of resources with options for specifying the start index, count, and desired fields.

```APIDOC
## GET /websites/wristband_dev

### Description
Retrieves a paginated list of resources. You can control the pagination by specifying the starting index and the number of items per page. You can also select specific fields to be returned in the response.

### Method
GET

### Endpoint
/websites/wristband_dev

### Parameters
#### Query Parameters
- **startIndex** (number) - Required - A 1-based index indicating the position of the first item that should be returned in the query response.
- **count** (number) - Optional - The maximum number of results that can be returned in a query response. If the value is set to 0 then the items array in the response will be empty; however the total results will still be set so you can see how many items this query matched. Defaults to 20.
- **fields** (string) - Optional - List of resource fields that should be returned in a response. The wildcard value of `*` can be used to return all fields for the resource. Defaults to `*`.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **totalResults** (integer) - The total number of results that satisfied the query expression.
- **startIndex** (integer) - A 1-based index representing the position of the first result in the returned query response.
- **itemsPerPage** (integer) - The number of results returned in a page.
- **items** (array) - Array of resources that satisfied the query criteria.

#### Response Example
```json
{
  "totalResults": 200,
  "startIndex": 1,
  "itemsPerPage": 10,
  "items": [
    {
      "id": "pl4a4aa4jzydksmrf3jnu5yfcw"
    }
  ]
}
```
```

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

### Project Configuration - Signup Options

Source: https://docs.wristband.dev/reference/queryapplicationtenantsv1

Defines various signup and login related configurations. This includes enabling signup, and providing URLs for custom signup pages, login pages, and error pages for both applications and tenants. These settings allow for a customized user experience.

```json
{
  "signupEnabled": true,
  "customApplicationSignupPageUrl": "http://app.example.com/app-signup",
  "customTenantSignupPageUrl": "http://app.example.com/tenant-signup",
  "customFindTenantPageUrl": "http://app.example.com/find-tenant",
  "customLoginPageUrl": "http://app.example.com/login",
  "customApplicationErrorPageUrl": "http://app.example.com/app-error",
  "customTenantErrorPageUrl": "http://app.example.com/tenant-error",
  "customExternalIdpApplicationSignupPageUrl": "http://app.example.com/external-idp-app-signup",
  "customExternalIdpTenantSignupPageUrl": "http://app.example.com/external-idp-tenant-signup",
  "customExternalIdpLoginPageUrl": "http://app.example.com/external-idp-login",
  "customExternalIdpInvitePageUrl": "http://app.example.com/external-idp-invite",
  "customExternalIdpChangeEmailPageUrl": "http://app.example.com/external-idp-change-email"
}
```

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

### Offset Pagination: Query Application Users

Source: https://docs.wristband.dev/reference/pagination

Demonstrates how to query application users using offset pagination. It shows example GET requests with `start_index` and `count` parameters, and the corresponding JSON responses including `totalResults` and `items`.

```http
GET https://yourapp-yourorg.us.wristband.dev/api/v1/applications/app123/users?start_index=1&count=2&sort_by=givenName:asc&fields=id,givenName
```

```http
GET https://yourapp-yourorg.us.wristband.dev/api/v1/applications/app123/users?start_index=3&count=2&sort_by=givenName:asc&fields=id,givenName
```

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

### Authenticate Get User API with cURL

Source: https://docs.wristband.dev/docs/getting-access-tokens-to-test-apis

This snippet shows how to make a GET request to the Wristband Get User API using cURL. It includes the necessary headers for authorization with a Bearer token, specifying the API endpoint and expected response format (JSON). Ensure you replace the placeholder token with your actual access token.

```shell
curl --request GET \
  --url https://yourapp-wristband.us.wristband.dev/api/v1/users/a3u2ixfpkvdkxcvtoidbhc5tly \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer eyJraWQiOiJiZWE0ejc0YzJmZmFqbzR4Y25lcWxhcnZ6eSIsInR5cCI6ImF0K0pXVCIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiJjYXk1a2NzbmZuYTd0Zm5wc3hxamt0cnNmNCIsInZhbl9kb20iOiJ5b3VyYXBwLXdyaXN0YmFuZC5kZXYud3Jpc3RiYW5kLmRldiIsImlzcyI6Imh0dHBzOlwvXC95b3VyYXBwLXdyaXN0YmFuZC5kZXYud3Jpc3RiYW5kLmRldiIsInN1Yl9raW5kIjoiYXBwbGljYXRpb25fY2xpZW50IiwiZXhwIjoxNjk0NjY3NTk3LCJhcHBfaWQiOiJueDNjeHQ1ZmdyZnlkbXJoYmhiaXRvYW02ZSIsImlhdCI6MTY5NDU4MTE5NywianRpIjoic2llYXp0anF0emVsZmhxZDJrZHEyZHdnNWEiLCJjbGllbnRfaWQiOiJjYXk1a2NzbmZuYTd0Zm5wc3hxamt0cnNmNCJ9.tS2sxxHL9--gXPjL3p6PStDmFBbRe-vMdyBYRFKWhNvRWKe8GNP61xe55TrNoElbkfxpGvoqJlv83torqkYbMwDxdWEa14dr5XiavbrL21pH3zm65tXfZM8gDAVXdQLFMwjTGRjpy5yS0LDy0QockUYaRBZdZmZEgI0zOG2x_DHxaDxBsyqTNPOjnfV0gX4m8CzYGe6GQU4JSyOHTe8iJ8feGiW_HnTOnvwq9VuzJdSbvelpxb6ZTuAoLxnT0DOMY0jZpUZahD6bpoJohMT4EgoXhW8Ok3qV4IQ2-7ZRZNh2MIhWnmc203yUNCiYDFvyyxB0DYbWvbd08G_PBU1AUA'
```

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

### Create Application

Source: https://docs.wristband.dev/reference/getapplicationv1

Creates a new application within the Wristband platform. This endpoint requires detailed configuration including domain name, display name, tenant settings, and login URLs.

```APIDOC
## POST /websites/wristband_dev/applications

### Description
Creates a new application with specified configuration details.

### Method
POST

### Endpoint
`/websites/wristband_dev/applications`

### Parameters
#### Request Body
- **domainName** (string) - Required - Domain name associated to the application. Must be unique and between 3-20 alphanumeric characters.
- **displayName** (string) - Required - A friendly name for the application, between 1-60 characters.
- **isMultiTenant** (boolean) - Required - Boolean indicating if the application supports multiple tenants.
- **environmentType** (string) - Required - The application's environment type. Enum: [DEVELOPMENT, PRODUCTION].
- **loginUrl** (string) - Required - The application's login URL. Can use `{tenant_domain}` token for multi-tenant apps.
- **tenantClassifier** (string) - Optional - The default classifier for tenants. Enum: [ACCOUNT, COMPANY, ORGANIZATION, TEAM, TENANT, WORKSPACE]. Default: TENANT.
- **logoutUrls** (array) - Optional - List of logout URLs. Max 10 unique URLs. Can use `{tenant_domain}` token.

### Request Example
```json
{
  "domainName": "application",
  "displayName": "My Application",
  "isMultiTenant": true,
  "environmentType": "DEVELOPMENT",
  "loginUrl": "http://app.example.com/auth/login",
  "tenantClassifier": "ORGANIZATION",
  "logoutUrls": [
    "http://app.example.com/logout"
  ]
}
```

### Response
#### Success Response (201 Created)
- **vanityDomain** (string) - The vanity domain for the application.
- **resolvedVanityDomain** (string) - The resolved vanity domain, potentially a custom domain.
- **domainName** (string) - The configured domain name.
- **displayName** (string) - The display name of the application.
- **isMultiTenant** (boolean) - Indicates if the application is multi-tenant.
- **tenantClassifier** (string) - The tenant classifier.
- **environmentType** (string) - The environment type.
- **loginUrl** (string) - The login URL.
- **loginUrlContainsTenantDomainToken** (boolean) - Indicates if the login URL contains the tenant domain token.
- **loginUrlTenantDomainSuffix** (string) - The suffix for tenant login URLs if applicable.

#### Response Example
```json
{
  "vanityDomain": "app-example.us.wristband.dev",
  "resolvedVanityDomain": "auth.app.com",
  "domainName": "application",
  "displayName": "My Application",
  "isMultiTenant": true,
  "tenantClassifier": "ORGANIZATION",
  "environmentType": "DEVELOPMENT",
  "loginUrl": "http://app.example.com/auth/login",
  "loginUrlContainsTenantDomainToken": true,
  "loginUrlTenantDomainSuffix": "app.example.com"
}
```
```
Tokens:
Raw