Clerk iOS

https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/
Admin
Clerk iOS is an SDK designed to integrate Clerk authentication and user management services into iOS...
Tokens:84,902
Snippets:674
Trust Score:9.7
Update:10 months ago
Show doc for...
Tokens:
Raw
### Swift: Example Usage of SignInWithAppleHelper

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/signinwithapplehelper

Demonstrates how to use the SignInWithAppleHelper class to obtain an Apple ID credential and then authenticate with the extracted ID token. This example highlights the async-await usage for a streamlined authentication process. Error handling is included for robustness.

```swift
do {
    // Create an instance of the helper and get the Apple ID credential.
    let appleIdCredential = try await SignInWithAppleHelper.getAppleIdCredential()


    // Extract the ID token from the credential.
    guard let idToken = appleIdCredential.identityToken.flatMap({ String(data: $0, encoding: .utf8) }) else {
        // throw an error
        fatalError("Failed to extract ID token")
    }


    // Authenticate with the extracted ID token.
    try await SignIn.authenticateWithIdToken(provider: .apple, idToken: idToken)
} catch {
    // Handle any errors.
    print("Authentication failed: \(error)")
}
```

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

### Initiate Sign-Up with Clerk Swift SDK

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/signup/create%28strategy%3Alegalaccepted%3A%29

Starts a new sign-up process using the specified strategy and optional legal acceptance. This method returns a `SignUp` object representing the current state of the sign-up flow. It handles communication with the Clerk API and manages sign-up lifecycle states.

```swift
@discardableResult @MainActor
static func create(
    strategy: SignUp.CreateStrategy,
    legalAccepted: Bool? = nil
) async throws -> SignUp
```

```swift
let signUp = try await SignUp.create(strategy: .standard(emailAddress: "user@email.com", password: "••••••••"))
```

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

### Swift Client Type Method: get()

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/client

An asynchronous type method on the Client object that retrieves the current client. This method is crucial for accessing the Client instance representing the current user session within the application.

```swift
static func get() async throws -> Client?
```

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

### Initiate Verification with prepareVerification(strategy:)

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/signup/prepareverification%28strategy%3A%29

The `prepareVerification(strategy:)` method starts the verification process for a specific field within a SignUp flow. It accepts a `PrepareStrategy` to define which field (email or phone number) needs verification and returns the updated `SignUp` object. This method is crucial for handling user verification via email codes or SMS.

```swift
@discardableResult @MainActor
func prepareVerification(strategy: SignUp.PrepareStrategy) async throws -> SignUp
```

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

### SignUp.authenticateWithRedirect

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/signup/authenticatewithredirect%28strategy%3Aprefersephemeralwebbrowsersession%3A%29

Creates a new SignUp and initiates an external authentication flow using a redirect-based strategy. Handles the process of creating a SignUp instance, starting an external web authentication session, and processing the callback URL upon successful authentication.

```APIDOC
## POST /v1/signups/redirect/start

### Description
Creates a new `SignUp` and initiates an external authentication flow using a redirect-based strategy. This method handles the process of creating a `SignUp` instance, starting an external web authentication session, and processing the callback URL upon successful authentication.

### Method
POST

### Endpoint
/v1/signups/redirect/start

### Parameters
#### Query Parameters
- **strategy** (SignUp.AuthenticateWithRedirectStrategy) - Required - The authentication strategy to use for the external authentication flow. Available options include OAuth providers (e.g., google, github) and other strategies.
- **prefersEphemeralWebBrowserSession** (Boolean) - Optional - A Boolean indicating whether to prefer an ephemeral web browser session. Defaults to `false`. When `true`, the session does not persist cookies or other data between sessions, ensuring a private browsing experience.

### Request Example
```swift
let result = try await SignUp.authenticateWithRedirect(strategy: .oauth(provider: .google))
```

### Response
#### Success Response (200)
- **TransferFlowResult** (TransferFlowResult) - An object containing the result of the external authentication flow, which can be either a `SignUp` or `SignIn` object.

#### Response Example
```json
{
  "signUp": {
    "id": "sign_abc123",
    "status": "complete",
    "userId": "user_xyz789"
  }
}
```

### Throws
- **ClerkClientError** - If the redirect URL is missing or invalid, or any errors encountered during the sign-up or authentication processes.
```

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

### Initiate Redirect Authentication Flow (Swift)

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/signup/authenticatewithredirect%28strategy%3Aprefersephemeralwebbrowsersession%3A%29

Creates a new SignUp and starts an external authentication flow using a redirect-based strategy. It handles session creation, web session initiation, and callback processing. Requires a valid OAuth provider or other supported strategy. Returns a TransferFlowResult on success or throws a ClerkClientError on failure.

```swift
@discardableResult @MainActor
static func authenticateWithRedirect(
    strategy: SignUp.AuthenticateWithRedirectStrategy,
    prefersEphemeralWebBrowserSession: Bool = false
) async throws -> TransferFlowResult
```

```swift
let result = try await SignUp.authenticateWithRedirect(strategy: .oauth(provider: .google))
```

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

### TransferFlowResult Example Usage

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/transferflowresult

Demonstrates how to use the TransferFlowResult enum with a switch statement to handle different outcomes of an authentication process, such as sign-in or sign-up transfers. This example utilizes the `authenticateWithRedirect` method.

```swift
let result = try await SignIn.authenticateWithRedirect(.oauth(provider: .google))

switch result {
case .signIn(let signIn):
    print("Proceed with sign-in: \(signIn)")
case .signUp(let signUp):
    print("Transferred to sign-up: \(signUp)")
}
```

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

### SignUp.CreateParams Initializer

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/signup/createparams/init%28strategy%3Afirstname%3Alastname%3Apassword%3Aemailaddress%3Aphonenumber%3Aweb3wallet%3Aus_efb7fd_ata%3Aredirecturl%3Aticket%3Atransfer%3Alegalaccepted%3Aoidcprompt%3Aoidcloginhint%3Atoken%3A%29

This section details the `init` method for `SignUp.CreateParams`, which allows you to configure the parameters for creating a new user sign-up. Various optional parameters are available to specify the sign-up strategy, user details, authentication methods, and more.

```APIDOC
## Initializer for SignUp.CreateParams

### Description
Initializes a `SignUp.CreateParams` object with optional parameters to configure user sign-up details.

### Method
`init`

### Parameters
#### Optional Parameters
- **strategy** (String?) - The sign-up strategy to use (e.g., 'email_code', 'email_password').
- **firstName** (String?) - The first name of the user.
- **lastName** (String?) - The last name of the user.
- **password** (String?) - The user's password (if using password-based strategy).
- **emailAddress** (String?) - The user's email address.
- **phoneNumber** (String?) - The user's phone number.
- **web3Wallet** (String?) - The user's Web3 wallet address.
- **username** (String?) - The user's desired username.
- **unsafeMetadata** (JSON?) - Unsafe metadata to attach to the sign-up. Use with caution.
- **redirectUrl** (String?) - The URL to redirect to after successful sign-up.
- **ticket** (String?) - A ticket for pre-verified sign-ups.
- **transfer** (Bool?) - Whether to transfer the sign-up to another user.
- **legalAccepted** (Bool?) - Indicates if the user has accepted the legal terms.
- **oidcPrompt** (String?) - The OIDC prompt parameter.
- **oidcLoginHint** (String?) - The OIDC login hint parameter.
- **token** (String?) - A token for specific sign-up flows.

### Request Example
```swift
let signUpParams = SignUp.CreateParams(
    firstName: "John",
    lastName: "Doe",
    emailAddress: "john.doe@example.com",
    password: "securePassword123"
)
```

### Response
This initializer does not directly return a response; it creates an instance of `SignUp.CreateParams`.
```

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

### SignUp.create API

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/signup/create%28_%3A%29

Initiates a new sign-up process and returns a SignUp object based on the provided strategy and optional parameters.

```APIDOC
## POST /sign-ups

### Description
Initiates a new sign-up process by sending the appropriate parameters to Clerk’s API. It deactivates any existing sign-up process and stores the sign-up lifecycle state in the `status` property of the new `SignUp` object. Clerk’s flexible sign-up process allows multi-step flows.

### Method
POST

### Endpoint
/sign-ups

### Parameters
#### Request Body
- **params** (Encodable & Sendable) - Required - A dictionary of parameters used to create the sign-up. The specific fields depend on the sign-up options enabled in your Clerk application instance (e.g., `email_address`, `password`).

### Request Example
```json
{
  "email_address": "user@email.com",
  "password": "••••••••"
}
```

### Response
#### Success Response (200)
- **SignUp** (Object) - A `SignUp` object containing the current status and details of the sign-up process. The `status` property reflects the current state of the sign-up.

#### Response Example
```json
{
  "id": "sign_123abc",
  "status": "needs_verification",
  "created_at": "2023-10-27T10:00:00Z",
  "updated_at": "2023-10-27T10:05:00Z",
  "external_param": null
}
```
```

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

### Swift Sign-Up Process Parameters

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/signup

Provides definitions for parameters used in various stages of the sign-up process. `CreateParams` is used to initiate and configure a sign-up, `PrepareVerificationParams` prepares for verification steps, and `AttemptVerificationParams` is used to execute the verification.

```swift
struct AttemptVerificationParams
struct CreateParams
struct PrepareVerificationParams
```

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

### Organization - Get Domain

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/organization/getdomain%28domainid%3A%29

Retrieves a specific domain associated with an organization using its unique ID.

```APIDOC
## GET /organizations/{organizationId}/domains/{domainId}

### Description
Retrieves a domain for an organization based on the given domain ID.

### Method
GET

### Endpoint
/organizations/{organizationId}/domains/{domainId}

### Parameters
#### Path Parameters
- **organizationId** (string) - Required - The ID of the organization.
- **domainId** (string) - Required - The ID of the domain to fetch.

### Request Example
(No request body for GET request)

### Response
#### Success Response (200)
- **domain** (OrganizationDomain) - An OrganizationDomain object containing details of the requested domain.

#### Response Example
```json
{
  "domain": {
    "id": "d6e8f3b2-a1c4-4e7d-8f9a-0b1c2d3e4f5a",
    "organizationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "name": "example.com",
    "status": "verified",
    "createdAt": "2023-10-27T10:00:00Z",
    "updatedAt": "2023-10-27T10:00:00Z"
  }
}
```
```

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

### GET /organizations/suggestions

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/user/getorganizationsuggestions%28initialpage%3Apagesize%3Astatus%3A%29

Retrieves a paginated list of organization suggestions for the current user. Supports filtering by status and pagination controls.

```APIDOC
## GET /organizations/suggestions

### Description
Retrieves a list of organization suggestions for the user. This endpoint allows for pagination and filtering by invitation status.

### Method
GET

### Endpoint
/organizations/suggestions

### Parameters
#### Query Parameters
- **initialPage** (Integer) - Optional - A number that can be used to skip the first n-1 pages. For example, if initialPage is set to 10, it will skip the first 9 pages and will fetch the 10th page. Defaults to 0.
- **pageSize** (Integer) - Optional - A number that indicates the maximum number of results that should be returned for a specific page. Defaults to 20.
- **status** (String) - Optional - The status an invitation can have. For example: 'pending', 'accepted', 'declined'.

### Request Example
```
GET /organizations/suggestions?initialPage=0&pageSize=20&status=pending
```

### Response
#### Success Response (200)
- **data** (Array<OrganizationSuggestion>) - A list of organization suggestion objects.
- **totalCount** (Integer) - The total number of available suggestions.
- **nextPage** (Integer) - The page number for the next set of results, or null if no more pages.

#### Response Example
```json
{
  "data": [
    {
      "id": "org_suggestion_id_1",
      "name": "Example Organization 1",
      "slug": "example-org-1",
      "status": "pending"
    },
    {
      "id": "org_suggestion_id_2",
      "name": "Example Organization 2",
      "slug": "example-org-2",
      "status": "pending"
    }
  ],
  "totalCount": 50,
  "nextPage": 1
}
```
```

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

### Instance Methods for SignUp

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/signup

Provides methods to interact with an existing sign-up process, such as attempting verification, authenticating, and updating.

```APIDOC
## Instance Methods for SignUp

### `attemptVerification(strategy: SignUp.AttemptStrategy) async throws -> SignUp`

#### Description
Attempts to complete the in-flight verification process that corresponds to the given strategy. In order to use this method, you should first initiate a verification process by calling SignUp.prepareVerification.

#### Method
`POST`

#### Endpoint
`/signup/verify/attempt`

#### Parameters
##### Request Body
- **strategy** (SignUp.AttemptStrategy) - Required - The strategy to use for attempting verification.

#### Response
##### Success Response (200)
- **SignUp** (Object) - The updated SignUp object.

### `authenticateWithIdToken() async throws -> TransferFlowResult`

#### Description
Authenticates the user using an ID Token and a specified provider.

#### Method
`POST`

#### Endpoint
`/signup/authenticate/idtoken`

#### Parameters
##### Request Body
- **provider** (IDTokenProvider) - Required - The authentication provider.
- **idToken** (String) - Required - The ID token for authentication.

#### Response
##### Success Response (200)
- **TransferFlowResult** (Object) - The result of the transfer flow.

### `authenticateWithRedirect(prefersEphemeralWebBrowserSession: Bool) async throws -> TransferFlowResult`

#### Description
Initiates an external authentication flow using a redirect-based strategy for the current `SignUp` instance.

#### Method
`POST`

#### Endpoint
`/signup/authenticate/redirect`

#### Parameters
##### Request Body
- **prefersEphemeralWebBrowserSession** (Bool) - Optional - Whether to prefer an ephemeral web browser session.

#### Response
##### Success Response (200)
- **TransferFlowResult** (Object) - The result of the transfer flow.

### `prepareVerification(strategy: SignUp.PrepareStrategy) async throws -> SignUp`

#### Description
The `prepareVerification` method is used to initiate the verification process for a field that requires it.

#### Method
`POST`

#### Endpoint
`/signup/verify/prepare`

#### Parameters
##### Request Body
- **strategy** (SignUp.PrepareStrategy) - Required - The strategy to use for preparing verification.

#### Response
##### Success Response (200)
- **SignUp** (Object) - The SignUp object with verification prepared.

### `update(params: SignUp.UpdateParams) async throws -> SignUp`

#### Description
This method is used to update the current sign-up.

#### Method
`PUT`

#### Endpoint
`/signup/update`

#### Parameters
##### Request Body
- **params** (SignUp.UpdateParams) - Required - The parameters to update the sign-up with.

#### Response
##### Success Response (200)
- **SignUp** (Object) - The updated SignUp object.

```

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

### GET /users/organization-invitations

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/user/getorganizationinvitations%28initialpage%3Apagesize%3A%29

Retrieves a paginated list of organization invitations for the current user. You can specify the initial page and the page size for the results.

```APIDOC
## GET /users/organization-invitations

### Description
Retrieves a list of organization invitations for the user. Allows for pagination by specifying the initial page and the number of items per page.

### Method
GET

### Endpoint
/users/organization-invitations

### Query Parameters
- **initialPage** (Integer) - Optional - A number that can be used to skip the first n-1 pages. For example, if initialPage is set to 10, it will skip the first 9 pages and will fetch the 10th page.
- **pageSize** (Integer) - Optional - A number that indicates the maximum number of results that should be returned for a specific page. Defaults to 20.

### Response
#### Success Response (200)
- **data** (Array<UserOrganizationInvitation>) - A list of user organization invitation objects.
- **totalCount** (Integer) - The total number of invitations available.
- **hasNextPage** (Boolean) - Indicates if there are more pages of results.

#### Response Example
```json
{
  "data": [
    {
      "id": "inv_someid",
      "emailAddress": "user@example.com",
      "status": "pending",
      "organization": {
        "id": "org_someid",
        "name": "Example Organization"
      }
    }
  ],
  "totalCount": 10,
  "hasNextPage": true
}
```
```

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

### GET /organizations/{organizationId}/membership_requests

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/organization/getmembershiprequests%28initialpage%3Apagesize%3Astatus%3A%29

Retrieves a paginated list of membership requests for the currently active organization. Supports filtering by status and pagination.

```APIDOC
## GET /organizations/{organizationId}/membership_requests

### Description
Retrieves the list of membership requests for the currently active organization. This method allows for pagination and filtering by request status.

### Method
GET

### Endpoint
/organizations/{organizationId}/membership_requests

### Parameters
#### Path Parameters
- **organizationId** (string) - Required - The unique identifier of the organization.

#### Query Parameters
- **initialPage** (integer) - Optional - Defaults to 0. A number that can be used to skip the first n-1 pages. For example, if `initialPage` is set to 10, it will skip the first 9 pages and fetch the 10th page.
- **pageSize** (integer) - Optional - Defaults to 20. A number that indicates the maximum number of results that should be returned for a specific page.
- **status** (string) - Optional - The status of the membership requests that will be included in the response. Possible values include 'pending', 'accepted', 'rejected'.

### Request Example
No request body is typically sent for a GET request of this nature.

### Response
#### Success Response (200)
- **data** (array) - An array of OrganizationMembershipRequest objects.
- **totalCount** (integer) - The total number of membership requests available.
- **hasNextPage** (boolean) - Indicates if there is a next page of results.

#### Response Example
```json
{
  "data": [
    {
      "id": "req_abc123",
      "organizationId": "org_xyz789",
      "userId": "user_def456",
      "role": "member",
      "status": "pending",
      "createdAt": "2023-10-27T10:00:00Z",
      "updatedAt": "2023-10-27T10:00:00Z"
    }
  ],
  "totalCount": 50,
  "hasNextPage": true
}
```
```

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

### Swift Client Initializers

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/client

Provides the initializers for the Client object. One initializer is for decoding from a Decoder, and another is a comprehensive initializer for creating a Client instance with all its properties, including session and sign-in/sign-up states.

```swift
init(from: any Decoder) throws
init(id: String, signIn: SignIn?, signUp: SignUp?, sessions: [Session], lastActiveSessionId: String?, updatedAt: Date)
```

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

### Get User Sessions

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/user

Retrieves all active sessions associated with the user. This asynchronous method returns an array of Session objects and can throw errors.

```swift
func getSessions() async throws -> [Session]
```

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

### User Initialization

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/user/init%28backupcodeenabled%3Acreatedat%3Acreateorganizationenabled%3Acreateorganizationslimit%3Ade_427918_Ahasimage%3Aid%3Aimageurl%3Alastsigninat%3Alastname%3Alegalacceptedat%3Aorganizationmember-4kodj

This section details the User initializer, including all its parameters and their types.

```APIDOC
## User Initializer

### Description
Initializes a `User` object with various properties related to authentication, organization, and personal information.

### Method
`init` (Swift Initializer)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

**Parameters:**
- **backupCodeEnabled** (Bool) - Indicates if backup codes are enabled for the user.
- **createdAt** (Date) - The date and time when the user account was created.
- **createOrganizationEnabled** (Bool) - Indicates if the user is enabled to create organizations.
- **createOrganizationsLimit** (Int?) - The limit on the number of organizations the user can create (optional).
- **deleteSelfEnabled** (Bool) - Indicates if the user is enabled to delete their own account.
- **emailAddresses** ([EmailAddress]) - An array of the user's email addresses.
- **enterpriseAccounts** ([EnterpriseAccount]?) - An array of the user's enterprise accounts (optional).
- **externalAccounts** ([ExternalAccount]) - An array of the user's external accounts.
- **firstName** (String?) - The user's first name (optional).
- **hasImage** (Bool) - Indicates if the user has an associated image.
- **id** (String) - The unique identifier for the user.
- **imageUrl** (String) - The URL of the user's image.
- **lastSignInAt** (Date?) - The date and time of the user's last sign-in (optional).
- **lastName** (String?) - The user's last name (optional).
- **legalAcceptedAt** (Date?) - The date and time when the user accepted the legal terms (optional).
- **organizationMemberships** ([OrganizationMembership]?) - An array of the user's organization memberships (optional).
- **passkeys** ([Passkey]) - An array of the user's passkeys.
- **passwordEnabled** (Bool) - Indicates if password authentication is enabled for the user.
- **phoneNumbers** ([PhoneNumber]) - An array of the user's phone numbers.
- **primaryEmailAddressId** (String?) - The ID of the user's primary email address (optional).
- **primaryPhoneNumberId** (String?) - The ID of the user's primary phone number (optional).
- **publicMetadata** (JSON?) - Publicly accessible metadata for the user (optional).
- **totpEnabled** (Bool) - Indicates if TOTP (Time-based One-Time Password) is enabled.
- **twoFactorEnabled** (Bool) - Indicates if two-factor authentication is enabled for the user.
- **updatedAt** (Date) - The date and time when the user's information was last updated.
- **unsafeMetadata** (JSON?) - Metadata for the user that should be treated as unsafe (optional).
- **username** (String?) - The user's username (optional).

### Request Example
```swift
let user = User(
    backupCodeEnabled: true,
    createdAt: Date(),
    createOrganizationEnabled: false,
    createOrganizationsLimit: 5,
    deleteSelfEnabled: true,
    emailAddresses: [],
    enterpriseAccounts: nil,
    externalAccounts: [],
    firstName: "Jane",
    hasImage: false,
    id: "user_123",
    imageUrl: "",
    lastSignInAt: nil,
    lastName: "Doe",
    legalAcceptedAt: nil,
    organizationMemberships: nil,
    passkeys: [],
    passwordEnabled: true,
    phoneNumbers: [],
    primaryEmailAddressId: nil,
    primaryPhoneNumberId: nil,
    publicMetadata: nil,
    totpEnabled: false,
    twoFactorEnabled: true,
    updatedAt: Date(),
    unsafeMetadata: nil,
    username: "jane.doe"
)
```

### Response
#### Success Response (200)
This is an initializer, so it doesn't return a response in the traditional API sense. It constructs a `User` object in memory.

#### Response Example
```swift
// User object created successfully
```
```

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

### URLEncodedFormEncoder.KeyPathEncoding.brackets

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/urlencodedformencoder/keypathencoding-swift.struct/brackets

Describes the 'brackets' encoding strategy for URLEncodedFormEncoder's KeyPathEncoding. This strategy encodes key paths by wrapping each component in brackets, for example, 'parent[child][grandchild]'.

```APIDOC
## URLEncodedFormEncoder.KeyPathEncoding.brackets

### Description
Encodes key paths by wrapping each component in brackets. e.g. `parent[child][grandchild]`.

### Method
static let

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (N/A)
N/A

#### Response Example
N/A
```

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

### Type Methods for SignUp

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/signup

Provides static methods for creating and authenticating sign-up processes.

```APIDOC
## Type Methods for SignUp

### `static func authenticateWithIdToken(provider: IDTokenProvider, idToken: String) async throws -> TransferFlowResult`

#### Description
Authenticates the user using an ID Token and a specified provider.

#### Method
`POST`

#### Endpoint
`/signup/authenticate/idtoken`

#### Parameters
##### Request Body
- **provider** (IDTokenProvider) - Required - The authentication provider.
- **idToken** (String) - Required - The ID token for authentication.

#### Response
##### Success Response (200)
- **TransferFlowResult** (Object) - The result of the transfer flow.

### `static func authenticateWithRedirect(strategy: SignUp.AuthenticateWithRedirectStrategy, prefersEphemeralWebBrowserSession: Bool) async throws -> TransferFlowResult`

#### Description
Creates a new `SignUp` and initiates an external authentication flow using a redirect-based strategy.

#### Method
`POST`

#### Endpoint
`/signup/authenticate/redirect`

#### Parameters
##### Request Body
- **strategy** (SignUp.AuthenticateWithRedirectStrategy) - Required - The strategy to use for authentication.
- **prefersEphemeralWebBrowserSession** (Bool) - Optional - Whether to prefer an ephemeral web browser session.

#### Response
##### Success Response (200)
- **TransferFlowResult** (Object) - The result of the transfer flow.

### `static func create<T>(T) async throws -> SignUp`

#### Description
Initiates a new sign-up process and returns a `SignUp` object based on the provided strategy and optional parameters.

#### Method
`POST`

#### Endpoint
`/signup/create`

#### Parameters
##### Request Body
- **T** (Generic Type) - Required - The strategy and optional parameters for sign-up.

#### Response
##### Success Response (200)
- **SignUp** (Object) - The newly created SignUp object.

### `static func create(strategy: SignUp.CreateStrategy, legalAccepted: Bool?) async throws -> SignUp`

#### Description
Initiates a new sign-up process and returns a `SignUp` object based on the provided strategy and optional parameters.

#### Method
`POST`

#### Endpoint
`/signup/create`

#### Parameters
##### Request Body
- **strategy** (SignUp.CreateStrategy) - Required - The strategy for initiating the sign-up request.
- **legalAccepted** (Bool?) - Optional - Indicates if legal terms have been accepted.

#### Response
##### Success Response (200)
- **SignUp** (Object) - The newly created SignUp object.

```

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

### GET /organizations/{organizationId}/domains

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/organization/getdomains%28initialpage%3Apagesize%3Aenrollmentmode%3A%29

Retrieves a paginated list of domains for a specific organization. Supports filtering by initial page and page size, and enrollment mode.

```APIDOC
## GET /organizations/{organizationId}/domains

### Description
Retrieves the list of domains for the currently active organization. Supports pagination and filtering by enrollment mode.

### Method
GET

### Endpoint
`/organizations/{organizationId}/domains`

### Parameters
#### Path Parameters
- **organizationId** (string) - Required - The ID of the organization whose domains are to be retrieved.

#### Query Parameters
- **initialPage** (integer) - Optional - A number that can be used to skip the first n-1 pages. For example, if `initialPage` is set to 10, it will skip the first 9 pages and fetch the 10th page. Defaults to 0.
- **pageSize** (integer) - Optional - A number that indicates the maximum number of results that should be returned for a specific page. Defaults to 20.
- **enrollmentMode** (string) - Optional - An enrollment mode will change how new users join an organization.

### Request Example
```json
{
  "message": "GET request to retrieve organization domains"
}
```

### Response
#### Success Response (200)
- **domains** (array[OrganizationDomain]) - A list of organization domain objects.
- **totalCount** (integer) - The total number of domains available.
- **nextPage** (integer) - The page number for the next set of results, or null if this is the last page.

#### Response Example
```json
{
  "domains": [
    {
      "id": "domain_abc123",
      "organizationId": "org_xyz789",
      "name": "example.com",
      "createdAt": "2023-10-27T10:00:00Z",
      "updatedAt": "2023-10-27T10:00:00Z"
    }
  ],
  "totalCount": 1,
  "nextPage": null
}
```
```

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

### Swift SignUp Initializer

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/signup

The initializer for the SignUp object. It takes numerous parameters to reconstruct the state of a sign-up, including identifiers, status, required and optional fields, verification details, user information, and metadata. This allows for the full restoration of a sign-up's context.

```swift
init(from: any Decoder) throws
init(id: String, status: SignUp.Status, requiredFields: [String], optionalFields: [String], missingFields: [String], unverifiedFields: [String], verifications: [String : Verification?], username: String?, emailAddress: String?, phoneNumber: String?, web3Wallet: String?, passwordEnabled: Bool, firstName: String?, lastName: String?, unsafeMetadata: JSON?, createdSessionId: String?, createdUserId: String?, abandonAt: Date)
```

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

### GET /organizations/{organizationId}/invitations

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/organization/getinvitations%28initialpage%3Apagesize%3Astatus%3A%29

Retrieves a paginated list of invitations for the currently active organization. You can specify the initial page, page size, and filter by invitation status.

```APIDOC
## GET /organizations/{organizationId}/invitations

### Description
Retrieves the list of invitations for the currently active organization.

### Method
GET

### Endpoint
`/organizations/{organizationId}/invitations`

### Parameters
#### Query Parameters
- **initialPage** (Int) - Optional - A number that can be used to skip the first n-1 pages. For example, if `initialPage` is set to 10, it will skip the first 9 pages and fetch the 10th page.
- **pageSize** (Int) - Optional - A number that indicates the maximum number of results that should be returned for a specific page. Defaults to 20.
- **status** (String) - Optional - The status an invitation can have.

### Response
#### Success Response (200)
- **data** (Array[OrganizationInvitation]) - A list of OrganizationInvitation objects.
- **totalCount** (Int) - The total number of invitations.
- **hasNextPage** (Boolean) - Indicates if there is a next page of results.

#### Response Example
```json
{
  "data": [
    {
      "id": "inv_abc123",
      "emailAddress": "test@example.com",
      "status": "pending",
      "role": "member",
      "invitedByUserId": "usr_xyz789",
      "createdAt": "2023-10-27T10:00:00Z",
      "updatedAt": "2023-10-27T10:00:00Z"
    }
  ],
  "totalCount": 1,
  "hasNextPage": false
}
```
```

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

### Initiate Verification Process

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/signup/prepareverification%28strategy%3A%29

This method initiates the verification process for a specified field, such as email or phone number, by sending a verification code. It returns the updated SignUp object.

```APIDOC
## prepareVerification(strategy:)

### Description
Initiates the verification process for a field that requires it. This method is used to send verification codes for fields like email addresses or phone numbers.

### Method
`async throws`

### Endpoint
N/A (Instance Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```swift
@discardableResult @MainActor
func prepareVerification(strategy: SignUp.PrepareStrategy) async throws -> SignUp
```

### Response
#### Success Response
- **SignUp** (SignUp) - The updated `SignUp` object reflecting the verification initiation.

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

### Discussion
The `strategy` parameter specifies which field needs verification. Supported strategies include verifying an `emailAddress` via email code or a `phoneNumber` via SMS.

```

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

### Swift SignUp Instance Properties

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/signup

Details the instance properties of the SignUp object, which represent the state and details of a sign-up. These include timestamps, identifiers for created sessions and users, user-provided information like email and name, status of fields and verifications, and metadata. These properties are crucial for tracking and managing the sign-up lifecycle.

```swift
let abandonAt: Date
let createdSessionId: String?
let createdUserId: String?
let emailAddress: String?
let firstName: String?
let id: String
let lastName: String?
let missingFields: [String]
let optionalFields: [String]
let passwordEnabled: Bool
let phoneNumber: String?
let requiredFields: [String]
let status: SignUp.Status
let unsafeMetadata: JSON?
let unverifiedFields: [String]
let username: String?
let verifications: [String : Verification?]
let web3Wallet: String?
```

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

### Get Organization Memberships for User

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/user

Retrieves a paginated list of organization memberships for the user. Requires initial page number and page size. This asynchronous method can throw errors.

```swift
func getOrganizationMemberships(initialPage: Int, pageSize: Int) async throws -> ClerkPaginatedResponse<OrganizationMembership>
```

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

### Get Organization Invitations for User

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/user

Retrieves a paginated list of organization invitations for the user. Requires initial page number and page size. This asynchronous method can throw errors.

```swift
func getOrganizationInvitations(initialPage: Int, pageSize: Int) async throws -> ClerkPaginatedResponse<UserOrganizationInvitation>
```

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

### SignUp Object

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/signup

The SignUp object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up process. Once a sign-up is complete, a new user is created.

```APIDOC
## SignUp Object

### Description
The `SignUp` object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up process. Once a sign-up is complete, a new user is created.

### Structure
```swift
struct SignUp
```

### The Sign-Up Process:
  1. **Initiate the Sign-Up** : Begin the sign-up process by collecting the user’s authentication information and passing the appropriate parameters to the `create()` method.
  2. **Prepare the Verification** : The system will prepare the necessary verification steps to confirm the user’s information.
  3. **Complete the Verification** : Attempt to complete the verification by following the required steps based on the collected authentication data.
  4. **Sign Up Complete** : If the verification is successful, the newly created session is set as the active session.

### Topics
#### Structures
- `struct AttemptVerificationParams`: Parameters used for the verification attempt during the sign-up process.
- `struct CreateParams`: Parameters used to create and configure a new sign-up process.
- `struct PrepareVerificationParams`: Parameters used to prepare the verification process for the sign-up flow.

#### Initializers
- `init(from: any Decoder) throws`
- `init(id: String, status: SignUp.Status, requiredFields: [String], optionalFields: [String], missingFields: [String], unverifiedFields: [String], verifications: [String : Verification?], username: String?, emailAddress: String?, phoneNumber: String?, web3Wallet: String?, passwordEnabled: Bool, firstName: String?, lastName: String?, unsafeMetadata: JSON?, createdSessionId: String?, createdUserId: String?, abandonAt: Date)`

#### Instance Properties
- **abandonAt** (Date) - The date when the sign-up was abandoned by the user.
- **createdSessionId** (String?) - The identifier of the newly-created session. This attribute is populated only when the sign-up is complete.
- **createdUserId** (String?) - The identifier of the newly-created user. This attribute is populated only when the sign-up is complete.
- **emailAddress** (String?) - The email address supplied to the current sign-up. Only supported if email address is enabled in the instance settings.
- **firstName** (String?) - The first name supplied to the current sign-up. Only supported if name is enabled in the instance settings.
- **id** (String) - The unique identifier of the current sign-up.
- **lastName** (String?) - The last name supplied to the current sign-up. Only supported if name is enabled in the instance settings.
- **missingFields** ([String]) - An array of all the fields whose values are not supplied yet but they are mandatory in order for a sign-up to be marked as complete.
- **optionalFields** ([String]) - An array of all the fields that can be supplied to the sign-up, but their absence does not prevent the sign-up from being marked as complete.
- **passwordEnabled** (Bool) - The value of this attribute is true if a password was supplied to the current sign-up. Only supported if password is enabled in the instance settings.
- **phoneNumber** (String?) - The user’s phone number in E.164 format. Only supported if phone number is enabled in the instance settings.
- **requiredFields** ([String]) - An array of all the required fields that need to be supplied and verified in order for this sign-up to be marked as complete and converted into a user.
- **status** (SignUp.Status) - The status of the current sign-up.
- **unsafeMetadata** (JSON?) - Metadata that can be read and set from the frontend. Once the sign-up is complete, the value of this field will be automatically copied to the newly created user’s unsafe metadata. One common use case for this attribute is to use it to implement custom fields that can be collected during sign-up and will automatically be attached to the created User object.
- **unverifiedFields** ([String]) - An array of all the fields whose values have been supplied, but they need additional verification in order for them to be accepted.
- **username** (String?) - The username supplied to the current sign-up. Only supported if username is enabled in the instance settings.
- **verifications** ([String : Verification?]) - An object that contains information about all the verifications that are in-flight.
- **web3Wallet** (String?) - The Web3 wallet address, made up of 0x + 40 hexadecimal characters. Only supported if Web3 authentication is enabled in the instance settings.
```

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

### Initialize Factor with Strategy

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/factor/init%28strategy%3Aemailaddressid%3Aphonenumberid%3Aweb3walletid%3Asafeidentifier%3Aprimary%3A%29

This initializer is used to create a new Factor instance. It requires a strategy string and accepts optional parameters for email, phone number, web3 wallet, safe identifier, and primary status. This allows for flexible configuration of authentication factors.

```swift
init(
    strategy: String,
    emailAddressId: String? = nil,
    phoneNumberId: String? = nil,
    web3WalletId: String? = nil,
    safeIdentifier: String? = nil,
    primary: Bool? = nil
)
```

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

### POST /authenticateWithRedirect

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/signin/authenticatewithredirect%28prefersephemeralwebbrowsersession%3A%29

Initiates an external authentication flow using a redirect-based strategy for the current SignIn instance. This method starts an external web authentication session and processes the callback URL upon successful authentication.

```APIDOC
## POST /authenticateWithRedirect

### Description
Initiates an external authentication flow using a redirect-based strategy for the current `SignIn` instance. This method starts an external web authentication session and processes the callback URL upon successful authentication.

### Method
POST

### Endpoint
/authenticateWithRedirect

### Parameters
#### Query Parameters
- **prefersEphemeralWebBrowserSession** (Boolean) - Optional - A Boolean indicating whether to prefer an ephemeral web browser session (default is `false`). When `true`, the session does not persist cookies or other data between sessions, ensuring a private browsing experience.

### Request Example
```swift
let signIn = try await SignIn.create(strategy: .oauth(provider: .google))
let result = try await signIn.authenticateWithRedirect()
```

### Response
#### Success Response (200)
- **TransferFlowResult** (TransferFlowResult) - An object containing the result of the external authentication flow which can be either a `SignIn` or `SignUp`.

#### Response Example
```json
{
  "result": "SignIn" or "SignUp"
}
```

### Error Handling
Throws an error of type `ClerkClientError` if the redirect URL is missing or invalid, or any errors encountered during the authentication process.
```

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

### URLEncodedFormEncoder.KeyEncoding.lowercased Swift Example

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/urlencodedformencoder/keyencoding-swift.enum/lowercased

The `lowercased` case of `URLEncodedFormEncoder.KeyEncoding` converts all characters in an encoded form key to lowercase. This is useful for ensuring case-insensitive key handling in URL-encoded forms. It takes a string as input and returns a lowercase version of that string.

```swift
case lowercased
```

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

### Initialize Clerk SignUpCreateParams with Various Parameters (Swift)

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/signup/createparams/init%28strategy%3Afirstname%3Alastname%3Apassword%3Aemailaddress%3Aphonenumber%3Aweb3wallet%3Aus_efb7fd_ata%3Aredirecturl%3Aticket%3Atransfer%3Alegalaccepted%3Aoidcprompt%3Aoidcloginhint%3Atoken%3A%29

This Swift code defines the initializer for the SignUp.CreateParams struct within the Clerk iOS SDK. It allows for the creation of sign-up requests with a comprehensive set of optional parameters including authentication strategy, user information, metadata, and redirect configurations. No external dependencies are required beyond the Clerk SDK itself.

```swift
init(
    strategy: String? = nil,
    firstName: String? = nil,
    lastName: String? = nil,
    password: String? = nil,
    emailAddress: String? = nil,
    phoneNumber: String? = nil,
    web3Wallet: String? = nil,
    username: String? = nil,
    unsafeMetadata: JSON? = nil,
    redirectUrl: String? = nil,
    ticket: String? = nil,
    transfer: Bool? = nil,
    legalAccepted: Bool? = nil,
    oidcPrompt: String? = nil,
    oidcLoginHint: String? = nil,
    token: String? = nil
)
```

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

### Get Paginated Roles (Swift)

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/organization/getroles%28initialpage%3Apagesize%3A%29

Retrieves a paginated list of RoleResource objects from Clerk. Supports skipping initial pages and setting the page size for results. This method is asynchronous and can throw errors.

```swift
@MainActor
func getRoles(
    initialPage: Int = 0,
    pageSize: Int = 20
) async throws -> ClerkPaginatedResponse<RoleResource>
```

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

### Get Organization Suggestions for User

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/user

Retrieves a paginated list of organization suggestions for the user, optionally filtered by status. Requires initial page number and page size. This asynchronous method can throw errors.

```swift
func getOrganizationSuggestions(initialPage: Int, pageSize: Int, status: String?) async throws -> ClerkPaginatedResponse<OrganizationSuggestion>
```

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

### SignIn Object Documentation

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/signin

This section provides detailed documentation for the SignIn object, including its purpose, the steps involved in the sign-in process, and its associated structures, initializers, properties, and methods.

```APIDOC
## SignIn Object

The `SignIn` object manages the state of the current sign-in process and offers helper methods to navigate and complete the sign-in lifecycle, including first and second factor verifications and session creation.

### Structures
- `AttemptFirstFactorParams`: Parameter object for attempting first factor verification.
- `AttemptSecondFactorParams`: Parameter object for attempting second factor verification.
- `ResetPasswordParams`: Parameter object for resetting a user's password.
- `SignInCreateParams`: Represents parameters required to initiate a sign-in flow.
- `UserData`: Contains information about the user once an identifier is provided.

### Initializers
- `init(from: any Decoder) throws`: Initializes a SignIn object from a decoder.
- `init(id: String, status: SignIn.Status, supportedIdentifiers: [SignIn.Identifier]?, identifier: String?, supportedFirstFactors: [Factor]?, supportedSecondFactors: [Factor]?, firstFactorVerification: Verification?, secondFactorVerification: Verification?, userData: SignIn.UserData?, createdSessionId: String?)`: Full initializer for the SignIn object.

### Instance Properties
- `createdSessionId` (String?): Identifier of the session created upon sign-in completion.
- `firstFactorVerification` (Verification?): State of the first factor verification process.
- `id` (String): Unique identifier for this sign-in.
- `identifier` (String?): Authentication identifier value for the current sign-in.
- `secondFactorVerification` (Verification?): State of the second factor verification process.
- `status` (SignIn.Status): The status of the current sign-in.
- `supportedFirstFactors` ([Factor]?): Array of supported first factors.
- `supportedIdentifiers` ([SignIn.Identifier]?): Array of supported authentication identifiers.
- `supportedSecondFactors` ([Factor]?): Array of supported second factors.
- `userData` (SignIn.UserData?): User information object.

### Instance Methods
- `attemptFirstFactor(strategy: SignIn.AttemptFirstFactorStrategy) async throws -> SignIn`: Attempts to complete the first factor verification process.
- `attemptSecondFactor(strategy: SignIn.AttemptSecondFactorStrategy) async throws -> SignIn`: Attempts to complete the second factor verification process (2FA).
- `authenticateWithIdToken() async throws -> TransferFlowResult`: Authenticates the user using an ID Token and a specified provider.
- `authenticateWithRedirect(prefersEphemeralWebBrowserSession: Bool) async throws -> TransferFlowResult`: Initiates an external authentication flow using a redirect-based strategy.
- `get(rotatingTokenNonce: String?) async throws -> SignIn`: Returns the current sign-in.
- `getCredentialForPasskey(autofill: Bool, preferImmediatelyAvailableCredentials: Bool) async throws -> String`: Presents the system sheet to allow the user to sign in using their passkey.
- `prepareFirstFactor(strategy: SignIn.PrepareFirstFactorStrategy) async throws -> SignIn`: Begins the first factor verification process.
- `prepareSecondFactor(strategy: SignIn.PrepareSecondFactorStrategy) async throws -> SignIn`: Begins the second factor verification process.
- `resetPassword(SignIn.ResetPasswordParams) async throws -> SignIn`: Resets a user’s password.
```

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

### Passkey Initialization

Source: https://swiftpackageindex.com/clerk/clerk-ios/main/documentation/clerk/passkey

Provides methods for initializing a Passkey object. Supports decoding from a data source and direct initialization with all necessary properties.

```swift
init(from: any Decoder) throws
init(id: String, name: String, verification: Verification?, createdAt: Date, updatedAt: Date, lastUsedAt: Date?)
```
Tokens:
Raw