Skip to content

Latest commit

 

History

History
93 lines (58 loc) · 8.24 KB

README.md

File metadata and controls

93 lines (58 loc) · 8.24 KB

SignUps

(sign_ups)

Overview

Available Operations

  • get - Retrieve a sign-up by ID
  • update - Update a sign-up

get

Retrieve the details of the sign-up with the given ID

Example Usage

from clerk_backend_api import Clerk


with Clerk(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as clerk:

    res = clerk.sign_ups.get(id="<id>")

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id str ✔️ The ID of the sign-up to retrieve
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.SignUp

Errors

Error Type Status Code Content Type
models.ClerkErrors 403 application/json
models.SDKError 4XX, 5XX */*

update

Update the sign-up with the given ID

Example Usage

from clerk_backend_api import Clerk


with Clerk(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as clerk:

    res = clerk.sign_ups.update(id="signup_1234567890abcdef", external_id="ext_id_7890abcdef123456", custom_action=False)

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
id str ✔️ The ID of the sign-up to update signup_1234567890abcdef
external_id OptionalNullable[str] ➖ The ID of the guest attempting to sign up as used in your external systems or your previous authentication solution.
This will be copied to the resulting user when the sign-up is completed.		 ext_id_7890abcdef123456
custom_action OptionalNullable[bool] ➖ If true, the sign-up will be marked as a custom action. false
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.SignUp

Errors

Error Type Status Code Content Type
models.ClerkErrors 403 application/json
models.SDKError 4XX, 5XX */*