Skip to main content

• User Directories
  • 🧑‍🤝‍🧑 Organizations
    • postCreate an Organization
    • delDelete an Organization
    • getList all Organizations
    • getRetrieve an Organization
    • putUpdate an Organization
  • 👩‍💻 Users
    • putAdd User Metadata
    • postCreate a User
    • delDelete a User By ID
    • getList all Users
    • putRemove User Metadata
    • getRetrieve a User By Email or ID
    • putUpdate a User
  • 🔄 Directory Syncs
    • postCreate a Directory Sync
    • getRetrieve a Directory Sync
    • putUpdate a Directory Sync
• Authentications
  • 🔌 SSO
    • postCreate an SSO Challenge
    • postCreate an SSO Connection
    • getList all SSO Connections
    • getRetrieve an SSO Connection
    • putUpdate an SSO Connection
  • 🔑 Password
    • postCreate a new Password
    • postCreate a Password Challenge
    • postCreate a Password Connection
    • postRequest a new Password via Magic Link
    • getRetrieve a Password Connection
    • putUpdate a Password Connection
  • ✨ Magic Link
    • postCreate a Magic Link Challenge
    • getRetrieve a Magic Link Connection
    • putUpdate a Magic Link Connection
  • 🔑 TOTP
    • postCreate a TOTP Challenge
    • postCreate a TOTP Enrollment
    • getRetrieve a TOTP Connection
    • putUpdate a TOTP Connection
    • putValidate a TOTP Challenge
    • putValidate a TOTP Enrollment
• Admins
  • ⚙️ Admin
    • postCreate the Admin
    • delDelete an Admin
    • getList all Admins
    • getRetrieve an Admin
• Others
  • 🔄 Webhook Setup
    • postCreate a Webhook
    • delDelete a Webhook
    • getList all Webhooks
    • getRetrieve a Webhook
    • putUpdate a Webhook
  • 📊 Webhook Events
    • postCancel Webhook Event
    • getList Webhook Events
    • postRetry Webhook Event
    • postTest Webhook Event
  • 🔂 Redirect URIs
    • postCreate a Redirect URI
    • delDelete a Redirect URI
    • getList all Redirect URIs
    • getRetrieve a Redirect URI
    • putSet Redirect URI as default
  • 🔐 Token
    • postCreate a Token
    • postCreate a User Metakey
    • getList all User Metakeys
    • delRemove a User MetaKey

API docs by Redocly](https://redocly.com/redoc/)

API reference (2.0)

Complete reference documentation for the Cryptr API. Includes code snippets and examples.

tag/Organizations 🧑‍🤝‍🧑 Organizations

The Organizations allows you to manage your business-to-business (B2B) customers, and segments strictly that end-users access their applications. Each end-user is stored in a distinct directory for a dedicated customer (Organization), and the end-user experience is customized in your colors with a white label user interface. An ( Organization) represents a business customer or partner in your Cryptr service.

• An ( Organization) represents a business customer or partner in your Cryptr service.

The Organization type

Each new organization gets a domain generated from its name. A domain is impossible to update because it's the identifier of the organization.

Copy Expand all Collapse all

`{"type": "Organization",

"allowed_email_domains": ["weeklymotion.com"

],

"color": "red-500",

"domain": "weeklymotion",

"environments": [{"name": "production",

"status": "down"

},

{"name": "sandbox",

"status": "down"

}

],

"icon_logo_url": "https://...",

"inline_logo_url": "https://...",

"inserted_at": "2023-05-10T06:16:35",

"locale": "en-US",

"name": "Weeklymotion",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"timezone": "Coordinated Universal Time (UTC)",

"updated_at": "2023-05-10T06:16:35"

}`

tag/Organizations/operation/create-organization Create an Organization

Creates a new Organization type with a name.

RETURNS

Returns an Organization if the creation succeeded. Returns an error if the create parameters are invalid (e.g., specifying an invalid code or an invalid source).

query Parameters

Responses

201

Created

422

Unprocessable Entity

post/api/v2/organizations

https://${{cryptr_service_url}}/api/v2/organizations

Request samples

• cURL

Copy

curl -X POST ${cryptr_service_url}/api/v2/organizations \
  -H "Authorization: Bearer your-access-token-from-client-id-and-secret" \
  -d name="Communitiz App" \
  -d allowed_email_domains[]="communitz-app"

Response samples

• 201
• 422

Content type

application/json

Copy Expand all Collapse all

`{"type": "Organization",

"allowed_email_domains": ["weeklymotion.com"

],

"color": "red-500",

"domain": "weeklymotion",

"environments": [{"name": "production",

"status": "down"

},

{"name": "sandbox",

"status": "down"

}

],

"icon_logo_url": "https://...",

"inline_logo_url": "https://...",

"inserted_at": "2023-05-04T07:16:56",

"locale": "en-US",

"name": "Weeklymotion",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"timezone": "Coordinated Universal Time (UTC)",

"updated_at": "2023-05-04T07:16:56"

}`

tag/Organizations/operation/delete-organization Delete an Organization

Delete an Organization with a domain.

RETURNS

Returns the deleted Organization.

path Parameters

Responses

200

OK

401

Unauthorized

delete/api/v2/organizations/{org_domain}

https://${{cryptr_service_url}}/api/v2/organizations/{org_domain}

Request samples

• cURL

Copy

curl -X DELETE
  '${cryptr_service_url}/api/v2/organizations/${org_domain}'

Response samples

• 200
• 401

Content type

application/json

Copy Expand all Collapse all

`{"deleted": true,

"resource": {"type": "Organization",

"allowed_email_domains": ["weeklymotion.com"

],

"color": "red-500",

"domain": "weeklymotion",

"environments": [{"name": "production",

"status": "down"

},

{"name": "sandbox",

"status": "down"

}

],

"icon_logo_url": "https://...",

"inline_logo_url": "https://...",

"inserted_at": "2023-05-04T07:16:56",

"locale": "en-US",

"name": "Weeklymotion",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"timezone": "Coordinated Universal Time (UTC)",

"updated_at": "2023-05-04T07:16:56"

}

}`

tag/Organizations/operation/list-organizations List all Organizations

Returns a list of your Organizations. The Organizations are returned sorted by creation date, with the most recent customers appearing first.

RETURNS

A dictionary with a data property that contains an array of up to the limit of Organizations. Each entry in the array represents a separate Organization type. If no Organizations are available, the resulting array will be empty. This request should never return an error.

query Parameters

Responses

200

OK

get/api/v2/organizations

https://${{cryptr_service_url}}/api/v2/organizations

Request samples

• cURL

Copy

curl '${cryptr_service_url}/api/v2/organizations' \
  -d "page=${page}" \
  -d "per_page=${per_page}" \
  -d "q[environments_status_in][]=up"

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"type": "List",

"data": [{"type": "Organization",

"allowed_email_domains": [ ],

"color": "red-500",

"domain": "actalab-corp-prod",

"environments": [{"name": "production",

"status": "up"

},

{"name": "sandbox",

"status": "up"

}

],

"icon_logo_url": "https://...",

"inline_logo_url": "https://...",

"inserted_at": "2023-06-08T08:13:54",

"locale": "en-US",

"name": "Actalab Corp Prod",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"timezone": "Coordinated Universal Time (UTC)",

"updated_at": "2023-06-08T08:14:12"

},

{"type": "Organization",

"allowed_email_domains": [ ],

"color": "red-500",

"domain": "actalab-corp-prod",

"environments": [{"name": "production",

"status": "up"

},

{"name": "sandbox",

"status": "up"

}

],

"icon_logo_url": "https://...",

"inline_logo_url": "https://...",

"inserted_at": "2023-06-08T08:13:54",

"locale": "en-US",

"name": "Actalab Corp Prod",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"timezone": "Coordinated Universal Time (UTC)",

"updated_at": "2023-06-08T08:14:12"

},

{"type": "Organization",

"allowed_email_domains": [ ],

"color": "red-500",

"domain": "tutux-corp-sandbox",

"environments": [{"name": "production",

"status": "down"

},

{"name": "sandbox",

"status": "up"

}

],

"icon_logo_url": "https://...",

"inline_logo_url": "https://...",

"inserted_at": "2023-06-08T08:08:53",

"locale": "en-US",

"name": "Tutux Corp Sandbox",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"timezone": "Coordinated Universal Time (UTC)",

"updated_at": "2023-06-08T08:09:10"

},

{"type": "Organization",

"allowed_email_domains": [ ],

"color": "red-500",

"domain": "tutux-corp-sandbox",

"environments": [{"name": "production",

"status": "down"

},

{"name": "sandbox",

"status": "up"

}

],

"icon_logo_url": "https://...",

"inline_logo_url": "https://...",

"inserted_at": "2023-06-08T08:08:53",

"locale": "en-US",

"name": "Tutux Corp Sandbox",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"timezone": "Coordinated Universal Time (UTC)",

"updated_at": "2023-06-08T08:09:10"

}

],

"pagination": {"current_page": 1,

"current_pages": [1

],

"next_page": null,

"per_page": 8,

"prev_page": null,

"total_pages": 1

},

"total": 4

}`

tag/Organizations/operation/retrieve-organization Retrieve an Organization

Fetch an Organization using its domain. The domain is generated from its name and serves as a unique and immutable value in your Cryptr service.

RETURNS

Returns the Organization for a valid identifier. If the identifier corresponds to a deleted Organization, a subset of its information is returned, including a 'deleted' property set to true.

path Parameters

Responses

200

OK

401

Unauthorized

get/api/v2/organizations/{org_domain}

https://${{cryptr_service_url}}/api/v2/organizations/{org_domain}

Request samples

• cURL

Copy

curl '${cryptr_service_url}/api/v2/organizations/${org_domain}'

Response samples

• 200
• 401

Content type

application/json

Copy Expand all Collapse all

`{"type": "Organization",

"allowed_email_domains": ["weeklymotion.com"

],

"color": "red-500",

"domain": "weeklymotion",

"environments": [{"name": "production",

"status": "down"

},

{"name": "sandbox",

"status": "down"

}

],

"icon_logo_url": "https://...",

"inline_logo_url": "https://...",

"inserted_at": "2023-05-04T07:16:56",

"locale": "en-US",

"name": "Weeklymotion",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"timezone": "Coordinated Universal Time (UTC)",

"updated_at": "2023-05-04T07:16:56"

}`

tag/Organizations/operation/update-organization Update an Organization

You can’t update the domain of an Organization. If you need to, you have to create a new one.

RETURNS

Returns the Organization if the update succeeded. Returns an error if the update parameters are invalid (e.g., specifying an invalid code or an invalid source).

path Parameters

query Parameters

Responses

200

OK

401

Unauthorized

422

Unprocessable Entity

put/api/v2/organizations/{org_domain}

https://${{cryptr_service_url}}/api/v2/organizations/{org_domain}

Request samples

• cURL

Copy

curl -X PUT
  '${cryptr_service_url}/api/v2/organizations/${org_domain}'

Response samples

• 200
• 401
• 422

Content type

application/json

Copy Expand all Collapse all

`{"type": "Organization",

"allowed_email_domains": ["weeklymotion.com"

],

"color": "red-500",

"domain": "weeklymotion",

"environments": [{"name": "production",

"status": "down"

},

{"name": "sandbox",

"status": "down"

}

],

"icon_logo_url": "https://...",

"inline_logo_url": "https://...",

"inserted_at": "2023-05-04T07:16:56",

"locale": "en-US",

"name": "Weeklymotion",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"timezone": "Coordinated Universal Time (UTC)",

"updated_at": "2023-05-04T07:16:56"

}`

tag/Users 👩‍💻 Users

Cryptr stores user profiles for your application in a dedicated hosted cloud database for a specific Organization. User profile information can come from your users directly. The sources are magic link signup, SSO (via SAML) logins, or Active Directory.

• A ( User) represents an end user of your customer or partner in your Cryptr service.

Your Cryptr subscription plan could limit the number of users. See our pricing for more details.

The User’s Organization domain

Each end user is stored in a distinct directory specific to a dedicated customer ( Organization). You can determine the domain of the user’s Organization from this user’s domain’s attribute.

The User type

Each new user gets a unique id (identifier) generated and which is impossible to update.

Copy Expand all Collapse all

`{"domain": "loirama",

"environment": "sandbox",

"type": "User",

"active": true,

"address": {"country": "FR",

"formatted": "165 avenue de Bretagne\n59000 Lille, France",

"locality": "Lille",

"postal_code": "59000",

"region": "Nord",

"street_address": "165 avenue de Bretagne"

},

"email": "lyla@loirama.co",

"email_verified": false,

"id": "d6a46443-c7bc-4259-aa5d-ce51cc548b57",

"identities": [ ],

"inserted_at": "2023-05-10T13:50:35",

"meta_data": [ ],

"phone_number": "+33 1 23 45 67 89",

"phone_number_verified": false,

"phone_numbers": [ ],

"profile": {"birthdate": "1992-03-10",

"family_name": "Bloggs",

"gender": "female",

"given_name": "Lyla",

"locale": "fr",

"nickname": "lylaB",

"picture": "https://www.cryptr.co",

"preferred_username": null,

"website": "http://www.example.com",

"zoneinfo": "France/Lille"

},

"updated_at": "2023-05-10T13:50:35"

}`

The Profile type

Copy

`{"birthdate": "1992-03-10",

"family_name": "Bloggs",

"gender": "female",

"given_name": "Lyla",

"locale": "fr",

"nickname": "lylaB",

"picture": "https://www.cryptr.co",

"preferred_username": null,

"website": "http://www.example.com",

"zoneinfo": "France/Lille"

}`

The Address type

Copy

`{"country": "FR",

"formatted": "165 avenue de Bretagne\n59000 Lille, France",

"locality": "Lille",

"postal_code": "59000",

"region": "Nord",

"street_address": "165 avenue de Bretagne"

}`

tag/Users/operation/add-user-metadata Add User Metadata

You can add a metadata key, which you have previously created using the Metakey request, by assigning a specific value to a user.

RETURNS

This request returns the user you selected if the creation is successful. If the metadata key is not declared in your account, an error will be returned.

path Parameters

query Parameters

Responses

200

OK

401

Unauthorized

404

Not Found

put/api/v2/org/{org_domain}/users/{id}/add-metadata

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/users/{id}/add-metadata

Request samples

• cURL

Copy

curl -X PUT '${cryptr_service_url}/api/v2/org/:org_domain/users/:user_id/add-metadata' \
  -d key='uid' \
  -d value='2fa42937'

Response samples

• 200
• 401
• 404

Content type

application/json

Copy Expand all Collapse all

`{"domain": "loirama",

"environment": "sandbox",

"type": "User",

"active": true,

"address": {"country": "FR",

"formatted": "165 avenue de Bretagne\n59000 Lille, France",

"locality": "Lille",

"postal_code": "59000",

"region": "Nord",

"street_address": "165 avenue de Bretagne"

},

"email": "lyla@loirama.co",

"email_verified": false,

"id": "d6a46443-c7bc-4259-aa5d-ce51cc548b57",

"identities": [ ],

"inserted_at": "2023-05-10T13:50:35",

"meta_data": [ ],

"phone_number": "+33 1 23 45 67 89",

"phone_number_verified": false,

"phone_numbers": [ ],

"profile": {"birthdate": "1992-03-10",

"family_name": "Bloggs",

"gender": "female",

"given_name": "Lyla",

"locale": "fr",

"nickname": "lylaB",

"picture": "https://www.cryptr.co",

"preferred_username": null,

"website": "http://www.example.com",

"zoneinfo": "France/Lille"

},

"updated_at": "2023-05-10T13:50:35"

}`

tag/Users/operation/create-user Create a User

Creates a new User in an Organization.

RETURNS

Returns a User attached to an Organization if the creation succeeded. Returns an error if the creation parameters are invalid (e.g., specifying an invalid code or an invalid source).

path Parameters

query Parameters

Responses

201

Created

422

Unprocessable Entity

post/api/v2/org/{org_domain}/users

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/users

Request samples

• cURL

Copy

curl -X POST '${cryptr_service_url}/api/v2/org/${org_domain}/users'
  --form 'profile[address][country]="FR"'
  --form 'profile[address][formatted]="165 avenue de Bretagne
  59000 Lille, France"'
  --form 'profile[address][locality]="Lille"'
  --form 'profile[address][postal_code]="59000"'
  --form 'profile[address][region]="Nord"'
  --form 'profile[address][street_address]="165 avenue de Bretagne"'
  --form 'profile[email]="lyla@loirama.co"'
  --form 'profile[birthdate]="1992-03-10"'
  --form 'profile[phone_number]="+33123456789"'
  --form 'profile[given_name]="Lyla"'
  --form 'profile[family_name]="Bloggs"'
  --form 'profile[nickname]="lylaB"'
  --form 'profile[picture]="https://www.cryptr.co"'
  --form 'profile[website]="http://www.example.com"'
  --form 'profile[gender]="female"'
  --form 'profile[zoneinfo]="France/Lille"'
  --form 'profile[locale]="fr"'

Response samples

• 201
• 422

Content type

application/json

Copy Expand all Collapse all

`{"domain": "loirama",

"environment": "sandbox",

"type": "User",

"active": true,

"address": {"country": "FR",

"formatted": "165 avenue de Bretagne\n59000 Lille, France",

"locality": "Lille",

"postal_code": "59000",

"region": "Nord",

"street_address": "165 avenue de Bretagne"

},

"email": "lyla@loirama.co",

"email_verified": false,

"id": "d6a46443-c7bc-4259-aa5d-ce51cc548b57",

"identities": [ ],

"inserted_at": "2023-05-10T13:50:35",

"meta_data": [ ],

"phone_number": "+33 1 23 45 67 89",

"phone_number_verified": false,

"phone_numbers": [ ],

"profile": {"birthdate": "1992-03-10",

"family_name": "Bloggs",

"gender": "female",

"given_name": "Lyla",

"locale": "fr",

"nickname": "lylaB",

"picture": "https://www.cryptr.co",

"preferred_username": null,

"website": "http://www.example.com",

"zoneinfo": "France/Lille"

},

"updated_at": "2023-05-10T13:50:35"

}`

tag/Users/operation/delete-user-by-id Delete a User By ID

Delete an existing user.

RETURNS

Returns a deleted User from an Organization.

path Parameters

Responses

200

OK

401

Unauthorized

delete/api/v2/org/{org_domain}/users/{id}

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/users/{id}

Request samples

• cURL

Copy

curl -X DELETE '${cryptr_service_url}/api/v2/org/${org_domain}/users/${user_id}'

Response samples

• 200
• 401

Content type

application/json

Copy Expand all Collapse all

`{"deleted": true,

"resource": {"domain": "b-oreal",

"environment": "sandbox",

"type": "User",

"active": true,

"address": {"country": "FR",

"formatted": "165 avenue de Bretagne\n59000 Lille, France",

"locality": "Lille",

"postal_code": "59000",

"region": "Nord",

"street_address": "165 avenue de Bretagne"

},

"email": "karim@b-oreal.co",

"email_verified": false,

"id": "796ffbba-1698-4b64-b667-5e5006fb52d2",

"identities": [ ],

"inserted_at": "2023-05-04T13:23:32",

"meta_data": [ ],

"phone_number": null,

"phone_number_verified": false,

"phone_numbers": [ ],

"profile": {"birthdate": "1992-03-10",

"family_name": "Guerra",

"gender": "male",

"given_name": "Karim",

"locale": "fr",

"nickname": "kGuerra",

"picture": "https://www.cryptr.co",

"preferred_username": null,

"website": "http://www.example.com",

"zoneinfo": "France/Lille"

},

"updated_at": "2023-05-04T13:23:32"

}

}`

tag/Users/operation/list-users List all Users

Returns a list of your users, sorted by creation date, with the most recent users appearing first.

RETURNS

A dictionary with a data property that contains an array of up to limit users. Each entry in the array represents a separate user type. If no users are available, the resulting array will be empty. This request should never return an error.

path Parameters

query Parameters

Responses

200

OK

401

Unauthorized

get/api/v2/org/{org_domain}/users

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/users

Request samples

• cURL

Copy

curl "${cryptr_service_url}/api/v2/org/${org_domain}/users" \
  -d page=${page}
  -d per_page=${per_page}

Response samples

• 200
• 401

Content type

application/json

Copy Expand all Collapse all

`{"type": "List",

"data": [{"domain": "b-oreal",

"environment": "sandbox",

"type": "User",

"active": true,

"address": {"country": "FR",

"formatted": "165 avenue de Bretagne\n59000 Lille, France",

"locality": "Lille",

"postal_code": "59000",

"region": "Nord",

"street_address": "165 avenue de Bretagne"

},

"email": "audrey@b-oreal.co",

"email_verified": false,

"id": "9aaf8fb9-89b8-488d-a5bc-dd61b7e63f2e",

"identities": [ ],

"inserted_at": "2023-05-04T13:24:49",

"meta_data": [ ],

"phone_number": null,

"phone_number_verified": false,

"phone_numbers": [ ],

"profile": {"birthdate": "1992-03-10",

"family_name": "Gallagher",

"gender": "female",

"given_name": "Audrey",

"locale": "fr",

"nickname": "aGallagher",

"picture": "https://www.cryptr.co",\
"preferred_username": null,

"website": "http://www.example.com",\
"zoneinfo": "France/Lille"

},

"updated_at": "2023-05-04T13:24:49"

},

{"domain": "b-oreal",

"environment": "sandbox",

"type": "User",

"active": true,

"address": {"country": "FR",

"formatted": "165 avenue de Bretagne\n59000 Lille, France",

"locality": "Lille",

"postal_code": "59000",

"region": "Nord",

"street_address": "165 avenue de Bretagne"

},

"email": "karim@b-oreal.co",

"email_verified": false,

"id": "796ffbba-1698-4b64-b667-5e5006fb52d2",

"identities": [ ],

"inserted_at": "2023-05-04T13:23:32",

"meta_data": [ ],

"phone_number": null,

"phone_number_verified": false,

"phone_numbers": [ ],

"profile": {"birthdate": "1992-03-10",

"family_name": "Guerra",

"gender": "male",

"given_name": "Karim",

"locale": "fr",

"nickname": "kGuerra",

"picture": "https://www.cryptr.co",\
"preferred_username": null,

"website": "http://www.example.com",\
"zoneinfo": "France/Lille"

},

"updated_at": "2023-05-04T13:23:32"

}

],

"pagination": {"current_page": 1,

"current_pages": [1,

2

],

"next_page": 2,

"per_page": 2,

"prev_page": null,

"total_pages": 2

},

"total": 3

}`

tag/Users/operation/remove-user-metadata Remove User Metadata

This request allows you to remove a metadata key assigned to a user.

RETURNS

This request returns the user you selected if the removal is successful. If the metadata key is not declared in your account, an error will be returned.

path Parameters

query Parameters

Responses

200

OK

401

Unauthorized

404

Not Found

put/api/v2/org/{org_domain}/users/{id}/remove-metadata

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/users/{id}/remove-metadata

Request samples

• cURL

Copy

curl -X PUT '${cryptr_service_url}/api/v2/org/:org_domain/users/:user_id/remove-metadata' \
  -d key='uid'

Response samples

• 200
• 401
• 404

Content type

application/json

Copy Expand all Collapse all

`{"domain": "loirama",

"environment": "sandbox",

"type": "User",

"address": {"country": "FR",

"formatted": "165 avenue de Bretagne\n59000 Lille, France",

"locality": "Lille",

"postal_code": "59000",

"region": "Nord",

"street_address": "165 avenue de Bretagne"

},

"email": "lyla@loirama.co",

"email_verified": false,

"id": "d6a46443-c7bc-4259-aa5d-ce51cc548b57",

"inserted_at": "2023-05-10T13:50:35",

"meta_data": [{"key": {"name": "uid",

"required": false,

"type": "string"

}

}

],

"phone_number": "+33 1 23 45 67 89",

"phone_number_verified": false,

"profile": {"birthdate": "1992-03-10",

"family_name": "Bloggs",

"gender": "female",

"given_name": "Lyla",

"locale": "fr",

"nickname": "lylaB",

"picture": "https://www.cryptr.co",

"preferred_username": null,

"website": "http://www.example.com",

"zoneinfo": "France/Lille"

},

"updated_at": "2023-05-10T13:50:35"

}`

tag/Users/operation/retrieve-user-by-email-or-id Retrieve a User By Email or ID

Fetch a User by their email or id.

RETURNS

Returns a User for a valid email or identifier. If the User has been deleted, a subset of their information is returned, including a deleted property set to true.

path Parameters

Responses

200

OK

401

Unauthorized

get/api/v2/org/{org_domain}/users/{email_or_id}

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/users/{email_or_id}

Request samples

• cURL

Copy

curl '${cryptr_service_url}/api/v2/org/${org_domain}/users/${user_id}'

Response samples

• 200
• 401

Content type

application/json

Copy Expand all Collapse all

`{"domain": "loirama",

"environment": "sandbox",

"type": "User",

"active": true,

"address": {"country": "FR",

"formatted": "165 avenue de Bretagne\n59000 Lille, France",

"locality": "Lille",

"postal_code": "59000",

"region": "Nord",

"street_address": "165 avenue de Bretagne"

},

"email": "lyla@loirama.co",

"email_verified": false,

"id": "d6a46443-c7bc-4259-aa5d-ce51cc548b57",

"identities": [ ],

"inserted_at": "2023-05-10T13:50:35",

"meta_data": [ ],

"phone_number": "+33 1 23 45 67 89",

"phone_number_verified": false,

"phone_numbers": [ ],

"profile": {"birthdate": "1992-03-10",

"family_name": "Bloggs",

"gender": "female",

"given_name": "Lyla",

"locale": "fr",

"nickname": "lylaB",

"picture": "https://www.cryptr.co",

"preferred_username": null,

"website": "http://www.example.com",

"zoneinfo": "France/Lille"

},

"updated_at": "2023-05-10T13:50:35"

}`

tag/Users/operation/update-user Update a User

Update an existing user.

RETURNS

Returns an updated Users from an Organization if the update succeeded. Returns an error if the creation parameters are invalid (e.g., specifying an invalid code or an invalid source).

path Parameters

query Parameters

Responses

200

OK

401

Unauthorized

422

Unprocessable Entity

put/api/v2/org/{org_domain}/users/{id}

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/users/{id}

Request samples

• cURL

Copy

curl -X PUT '${cryptr_service_url}/api/v2/org/${org_domain}/users/${user_id}'
        --form 'address[country]="FR"'
        --form 'address[formatted]="165 avenue de Bretagne
        59000 Lille, France"'
        --form 'address[locality]="Lille"'
        --form 'address[postal_code]="59000"'
        --form 'address[region]="Nord"'
        --form 'address[street_address]="165 avenue de Bretagne"'
        --form 'email="lyla@loirama.co"'
        --form 'phone_number="+33123456789"'
        --form 'profile[birthdate]="1992-03-10"'
        --form 'profile[given_name]="Lyla"'
        --form 'profile[family_name]="Bloggs"'
        --form 'profile[nickname]="lylaB"'
        --form 'profile[picture]="https://www.cryptr.co"'
        --form 'profile[website]="http://www.example.com"'
        --form 'profile[gender]="female"'
        --form 'profile[zoneinfo]="France/Lille"'
        --form 'profile[locale]="fr"'

Response samples

• 200
• 401
• 422

Content type

application/json

Copy Expand all Collapse all

`{"domain": "loirama",

"environment": "sandbox",

"type": "User",

"active": true,

"address": {"country": "FR",

"formatted": "165 avenue de Bretagne\n59000 Lille, France",

"locality": "Lille",

"postal_code": "59000",

"region": "Nord",

"street_address": "165 avenue de Bretagne"

},

"email": "lyla@loirama.co",

"email_verified": false,

"id": "d6a46443-c7bc-4259-aa5d-ce51cc548b57",

"identities": [ ],

"inserted_at": "2023-05-10T13:50:35",

"meta_data": [ ],

"phone_number": "+33 1 23 45 67 89",

"phone_number_verified": false,

"phone_numbers": [ ],

"profile": {"birthdate": "1992-03-10",

"family_name": "Bloggs",

"gender": "female",

"given_name": "Lyla",

"locale": "fr",

"nickname": "lylaB",

"picture": "https://www.cryptr.co",

"preferred_username": null,

"website": "http://www.example.com",

"zoneinfo": "France/Lille"

},

"updated_at": "2023-05-10T13:50:35"

}`

tag/Directory-Syncs 🔄 Directory Syncs

The term Directory Sync in Cryptr refers to the SCIM protocol defined in RFCs 7642, 7643 & 7644. It allows you to synchronize the changes that take place on your user base.

For example, when a user is created, the change is automatically recognized and propagated. SCIM handles creations, deletions, and updates.

The Directory Sync type

The number of directory syncs you can create is limited. You can create only one Directory Sync per organization domain and environment pair. For instance, if your organization domain is misapret and you have a sandbox environment, you can create only one Directory Sync for "misapret/sandbox". However, if you also have a production environment, you can create an additional Directory Sync for the "misapret/production" pair.

Copy Expand all Collapse all

`{"domain": "barker-inc",

"environment": "sandbox",

"type": "DirectorySync",

"active": true,

"auth_secret_token": {"hint": "You must save this value. If you lose it you will have to create a new one using the reset endpoint.",

"provider_key": "OAuth Bearer Token",

"value": "barker-inc.sandbox.48789cb6-33c3-47fe-bb92-8774cda6d327.CrVrhHZuQfVgGuKkYY7lvBMgsqRU15flunxYOrOhPfGg6IW6wDA2ic41MRMQfge0O_kBXRjLbI4HqFaxBfTdqtbzmGTiFbRZmoIgjjeuqBwROiDprKUQqVAjad3CXjd8"

},

"id": "32dad740-142e-4af3-ac69-de5f36915d80",

"inserted_at": "2023-06-15T09:23:55",

"provider_type": null,

"updated_at": "2023-06-15T09:23:55"

}`

tag/Directory-Syncs/operation/create-directory-sync Create a Directory Sync

Creates a new Directory Sync in an Organization. When you create a Directory Sync, you will receive the associated bearer token.

Note: When you create a Directory Sync, the environment of your API key determines where your Directory Sync is stored. For example, a Directory Sync in the sandbox environment is created only if the API key used belongs to the sandbox environment. You cannot create a Directory Sync for the Production environment with an API key meant for another environment; you need an API key dedicated to the Production environment.

path Parameters

Responses

201

Created

401

Unauthorized

409

Conflict

post/api/v2/org/{org_domain}/directory-sync

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/directory-sync

Request samples

• cURL

Copy

curl -X POST '${cryptr_service_url}/api/v2/org/${org_domain}/directory-sync'

Response samples

• 201
• 401
• 409

Content type

application/json

Copy Expand all Collapse all

`{"domain": "barker-inc",

"environment": "sandbox",

"type": "DirectorySync",

"active": true,

"auth_secret_token": {"hint": "You must save this value. If you lose it you will have to create a new one using the reset endpoint.",

"provider_key": "OAuth Bearer Token",

},

"id": "32dad740-142e-4af3-ac69-de5f36915d80",

"inserted_at": "2023-06-15T09:23:55",

"provider_type": null,

"updated_at": "2023-06-15T09:23:55"

}`

tag/Directory-Syncs/operation/retrieve-directory-sync Retrieve a Directory Sync

Fetch a Directory Sync by its organization owner and environment (production, sandbox...).

Note: When you fetch a Directory Sync, the environment of your API key determines where your Directory Sync is stored. For example, your Directory Sync in the sandbox environment is fetched only if this resource is stored in sandbox. You cannot fetch a Directory Sync from the Production environment with this API key; you need an API key dedicated to the Production environment.

RETURNS

Returns the Directory Sync for a valid organization/environment pair. If the Directory Sync has been deleted, a NoResult response is returned.

path Parameters

Responses

200

OK

get/api/v2/org/{org_domain}/directory-sync

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/directory-sync

Request samples

• cURL

Copy

curl -X '${cryptr_service_url}/api/v2/org/${org_domain}/directory-sync'

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"domain": "barker-inc",

"environment": "sandbox",

"type": "DirectorySync",

"active": true,

"auth_secret_token": {"hint": "This value is only displayed once at creation. If you have lost this value and wish to recover it, please consider using the reset endpoint.",

"provider_key": "OAuth Access Token",

"value": "hidden"

},

"id": "32dad740-142e-4af3-ac69-de5f36915d80",

"inserted_at": "2023-06-15T09:23:55",

"provider_type": null,

"updated_at": "2023-06-15T12:11:17"

}`

tag/Directory-Syncs/operation/update-directory-sync Update a Directory Sync

Update an existing Directory Sync in an organization. The only update allowed is to change the active field.

RETURNS

Returns the updated Directory Sync for a valid organization/environment pair. If the Directory Sync has been deleted, a NoResult response is returned.

path Parameters

query Parameters

Responses

200

OK

401

Unauthorized

put/api/v2/org/{org_domain}/directory-sync

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/directory-sync

Request samples

• cURL

Copy

curl -X PUT '${cryptr_service_url}/api/v2/org/${org_domain}/directory-sync'

Response samples

• 200
• 401

Content type

application/json

Copy Expand all Collapse all

`{"domain": "barker-inc",

"environment": "sandbox",

"type": "DirectorySync",

"active": true,

"auth_secret_token": {"hint": "You must save this value. If you lose it you will have to create a new one using the reset endpoint.",

"provider_key": "OAuth Bearer Token",

},

"id": "32dad740-142e-4af3-ac69-de5f36915d80",

"inserted_at": "2023-06-15T09:23:55",

"provider_type": null,

"updated_at": "2023-06-15T09:23:55"

}`

tag/SSO 🔌 SSO

You can create or update SSO connection preferences for an organization (usually your enterprise customer). This includes setting up, attaching, creating a redirection for end-user login, or interacting with the administrator of the SSO.

Cryptr supports the following SSO provider solutions:

• Azure Active Directory
• ADFS
• Google
• Okta
• Ping Federate (Ping Identity)
• Ping One (Ping Identity)
• Auth0
• OneLogin
• Custom SAML

By default, user profile attributes provided by identity providers (the SSO solution of your customers) are not directly editable because they are updated from the identity provider each time the user logs in.

To be able to edit the name, nickname, given_name, family_name, or picture root attributes on the normalized user profile, you must configure your connection sync with Cryptr so that user attributes are updated from the identity provider only upon user profile creation.

You can add and edit root attributes individually or via bulk import using the Management API. You'll find these attributes in the final JWT (JSON Web Token) after successful SSO authentication.

• A ( User) represents an end user for your customer or partner in your Cryptr service.

Your Cryptr subscription plan may limit the number of users. See our pricing for more details.

Copy Expand all Collapse all

`{"type": "SsoConnection",

"active": true,

"id": "barker_inc_S6f5ndf8mZqfoBKoxEotMV",

"inserted_at": "2023-06-08T13:47:41",

"number_users_provisioning_limit": 99,

"organization": {"type": "Organization",

"allowed_email_domains": ["barker.co"

],

"domain": "barker-inc",

"environments": [{"name": "production",

"status": "down"

},

{"name": "sandbox",

"status": "up"

}

],

"inserted_at": "2023-06-08T12:12:28",

"name": "Barker",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"updated_at": "2023-06-08T12:37:59"

},

"provider_type": "saml.azure_ad",

"saml_config": {"acs_url": "https://www.cryptr.co",

"cryptr_metadata_url": "https://www.cryptr.co",

"entity_id": "shark_academy_MgF6Z9maZKriEBbLM9KZJj",

"slo_response_url": "https://www.cryptr.co",

"slo_url": "https://www.cryptr.co",

"sso_provider_metadata": null

},

"sp_id": "shark_academy_MgF6Z9maZKriEBbLM9KZJj",

"updated_at": "2023-06-08T13:47:41",

"users_access_policy": "provision_new_users"

}`

Before you can create an SSO challenge, you must first set up an SSO connection.

An SSO challenge is a secure validation process used in single sign-on (SSO). It requires the user to successfully complete an authentication request to verify their identity and gain access to SSO-protected services.

The SSO Challenge type

Copy

`{"environment": "sandbox",

"type": "SsoChallenge",

"authorization_url": "https//your-cryptr-service-url.com/org/loirama/oauth2/saml?request_id=8d814d02-35d8-48a9-a033-291fd5959a0c",

"expired_at": 1684774623,

"redirect_uri": "https://b-oreal.com/welcome-back-user",

"request_id": "8d814d02-35d8-48a9-a033-291fd5959a0c",

"sso_connection_id": "loirama_VqiFf3Y5ogaYRbyEyazDWn"

}`

tag/SSO/operation/create-sso-challenge (2) Create an SSO Challenge

Create an SSO Challenge to strengthen security and simplify user authentication.

RETURNS

Returns information such as the authorization URL, the redirection URL, and other identifiers associated with the Challenge SSO created.

query Parameters

Responses

201

Created

post/api/v2/sso-saml-challenge

https://${{cryptr_service_url}}/api/v2/sso-saml-challenge

Request samples

• cURL

Copy

curl -X POST '${cryptr_service_url}/api/v2/sso-saml-challenge' \
  -d user_email="lyla@loirama.co" \
  -d redirect_uri="https://loirama.com/welcome-back-user" \
  // Use the following option if you prefer to use org_domain instead of user_email \
  // -d org_domain="loirama"

Response samples

• 201

Content type

application/json

Copy

`{"environment": "sandbox",

"type": "SsoChallenge",

"authorization_url": "https//your-cryptr-service-url.com/org/loirama/oauth2/saml?request_id=8d814d02-35d8-48a9-a033-291fd5959a0c",

"expired_at": 1684774623,

"redirect_uri": "https://loirama.com/welcome-back-user",

"request_id": "8d814d02-35d8-48a9-a033-291fd5959a0c",

"sso_connection_id": "loirama_VqiFf3Y5ogaYRbyEyazDWn"

}`

tag/SSO/operation/create-sso-connection Create an SSO Connection

Creates a new SSO connection type. The response automatically expands the onboarding nested element.

RETURNS

Returns an SSO Connection if the creation succeeds.

path Parameters

query Parameters

Responses

201

Created

post/api/v2/org/{org_domain}/sso-connection

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/sso-connection

Request samples

• cURL

Copy

curl -X POST '${cryptr_service_url}/api/v2/org/${org_domain}/sso-connection'

Response samples

• 201

Content type

application/json

Copy Expand all Collapse all

`{"type": "SsoConnection",

"active": true,

"id": "barker_inc_S6f5ndf8mZqfoBKoxEotMV",

"inserted_at": "2023-06-08T13:47:41",

"number_users_provisioning_limit": 99,

"organization": {"type": "Organization",

"allowed_email_domains": ["barker.co"

],

"domain": "barker-inc",

"environments": [{"name": "production",

"status": "down"

},

{"name": "sandbox",

"status": "up"

}

],

"inserted_at": "2023-06-08T12:12:28",

"name": "Barker",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"updated_at": "2023-06-08T12:37:59"

},

"provider_type": "saml.azure_ad",

"saml_config": {"acs_url": "https://www.cryptr.co",

"cryptr_metadata_url": "https://www.cryptr.co",

"entity_id": "shark_academy_MgF6Z9maZKriEBbLM9KZJj",

"slo_response_url": "https://www.cryptr.co",

"slo_url": "https://www.cryptr.co",

"sso_provider_metadata": null

},

"sp_id": "shark_academy_MgF6Z9maZKriEBbLM9KZJj",

"updated_at": "2023-06-08T13:47:41",

"users_access_policy": "provision_new_users"

}`

tag/SSO/operation/list-sso-connections List all SSO Connections

List all your SSO connections currently created, regardless of the progress of the configuration.

RETURNS

Returns list of SSO Connections with nested objects if preload_associations is set, and paginated if related attributes are present.

query Parameters

Responses

200

OK

get/api/v2/sso-connections

https://${{cryptr_service_url}}/api/v2/sso-connections

Request samples

• cURL

Copy

curl '${cryptr_service_url}/api/v2/sso-connections'
          -d page=${page}
          -d per_page=${per_page}

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"type": "List",

"data": [{"type": "SsoConnection",

"id": "barker_inc_ENbw8MukSNtTKCqPZC2U7g",

"inserted_at": "2023-06-09T14:23:09",

"number_users_provisioning_limit": 99,

"organization": {"type": "Organization",

"allowed_email_domains": ["barker.co"

],

"domain": "barker-inc",

"environments": [{"name": "production",

"status": "down"

},

{"name": "sandbox",

"status": "up"

}

],

"inserted_at": "2023-06-08T12:12:28",

"name": "Barker",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"updated_at": "2023-06-08T12:37:59"

},

"provider_type": "saml.azure_ad",

"saml_config": {"acs_url": "https://www.cryptr.co",\
"cryptr_metadata_url": "https://www.cryptr.co",\
"entity_id": "shark_academy_MgF6Z9maZKriEBbLM9KZJj",

"slo_response_url": "https://www.cryptr.co",\
"slo_url": "https://www.cryptr.co",\
"sso_provider_metadata": null

},

"sp_id": "shark_academy_MgF6Z9maZKriEBbLM9KZJj",

"updated_at": "2023-06-09T14:23:09",

"users_access_policy": "provision_new_users"

},

{"type": "SsoConnection",

"id": "looney_tunes_gNT8hCyC7MsovKaLFWnSUh",

"inserted_at": "2023-05-26T07:22:47",

"number_users_provisioning_limit": null,

"organization": {"type": "Organization",

"allowed_email_domains": ["Looney_tunes.co"

],

"domain": "looney-tunes",

"environments": [{"name": "sandbox",

"status": "up"

},

{"name": "production",

"status": "up"

}

],

"inserted_at": "2023-05-26T07:21:20",

"name": "Looney tunes",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"updated_at": "2023-05-26T07:21:40"

},

"provider_type": "unset",

"saml_config": {"acs_url": "https://www.cryptr.co",\
"cryptr_metadata_url": "https://www.cryptr.co",\
"entity_id": "shark_academy_MgF6Z9maZKriEBbLM9KZJj",

"slo_response_url": "https://www.cryptr.co",\
"slo_url": "https://www.cryptr.co",\
"sso_provider_metadata": null

},

"sp_id": "shark_academy_MgF6Z9maZKriEBbLM9KZJj",

"updated_at": "2023-05-26T07:22:47",

"users_access_policy": "provision_new_users"

}

],

"pagination": {"current_page": 1,

"current_pages": [1,

2,

3,

"...",

26

],

"next_page": 2,

"per_page": 2,

"prev_page": null,

"total_pages": 26

},

"total": 52

}`

tag/SSO/operation/retrieve-sso-connection Retrieve an SSO Connection

Fetch an SSO connection, useful to know its configuration and also fetch nested object onboarding.

RETURNS

Returns the SSO Connection

path Parameters

Responses

200

OK

get/api/v2/org/{org_domain}/sso-connection

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/sso-connection

Request samples

• cURL

Copy

curl '${cryptr_service_url}/api/v2/org/${org_domain}/sso-connection'

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"type": "SsoConnection",

"active": true,

"id": "barker_inc_S6f5ndf8mZqfoBKoxEotMV",

"inserted_at": "2023-06-08T13:47:41",

"number_users_provisioning_limit": 99,

"organization": {"type": "Organization",

"allowed_email_domains": ["barker.co"

],

"domain": "barker-inc",

"environments": [{"name": "production",

"status": "down"

},

{"name": "sandbox",

"status": "up"

}

],

"inserted_at": "2023-06-08T12:12:28",

"name": "Barker",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"updated_at": "2023-06-08T12:37:59"

},

"provider_type": "saml.azure_ad",

"saml_config": {"acs_url": "https://www.cryptr.co",

"cryptr_metadata_url": "https://www.cryptr.co",

"entity_id": "shark_academy_MgF6Z9maZKriEBbLM9KZJj",

"slo_response_url": "https://www.cryptr.co",

"slo_url": "https://www.cryptr.co",

"sso_provider_metadata": null

},

"sp_id": "shark_academy_MgF6Z9maZKriEBbLM9KZJj",

"updated_at": "2023-06-08T13:47:41",

"users_access_policy": "provision_new_users"

}`

tag/SSO/operation/update-sso-connection Update an SSO Connection

Fetch an SSO connection, useful to know its configuration and also fetch nested object onboarding.

RETURNS

Returns the updated SSO Connection

path Parameters

query Parameters

Responses

200

OK

put/api/v2/org/{org_domain}/sso-connection

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/sso-connection

Request samples

• cURL

Copy

curl -X PUT 'https://${YOUR_CRYPTR_SERVICE_URL}/api/v2/sso-connections/:idp_id' \
  --header 'Authorization: Bearer your_api_key_generated_token' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "number_users_provisioning_limit": 99
}'

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"type": "SsoConnection",

"active": true,

"id": "barker_inc_S6f5ndf8mZqfoBKoxEotMV",

"inserted_at": "2023-06-08T13:47:41",

"number_users_provisioning_limit": 99,

"organization": {"type": "Organization",

"allowed_email_domains": ["barker.co"

],

"domain": "barker-inc",

"environments": [{"name": "production",

"status": "down"

},

{"name": "sandbox",

"status": "up"

}

],

"inserted_at": "2023-06-08T12:12:28",

"name": "Barker",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"updated_at": "2023-06-08T12:37:59"

},

"provider_type": "saml.azure_ad",

"saml_config": {"acs_url": "https://www.cryptr.co",

"cryptr_metadata_url": "https://www.cryptr.co",

"entity_id": "shark_academy_MgF6Z9maZKriEBbLM9KZJj",

"slo_response_url": "https://www.cryptr.co",

"slo_url": "https://www.cryptr.co",

"sso_provider_metadata": null

},

"sp_id": "shark_academy_MgF6Z9maZKriEBbLM9KZJj",

"updated_at": "2023-06-08T13:47:41",

"users_access_policy": "provision_new_users"

}`

tag/Password 🔑 Password

Headless Password Challenges

Password challenge is a secure validation process for password. It involves an authentication request sent to the user, who must pass a challenge to prove his identity and access protected services.

The Password Challenge type

Copy

`{"domain": "loirama",

"environment": "production",

"type": "PasswordChallenge",

"code": "iIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6NDAwMC90L2Jsb2NrcHVsc2UiLCJraWQ",

"error": null,

"expired_at": null,

"password_id": 145,

"renew_password": null,

"request_id": "edead972-68e1-49ea-8257-c0584cded957",

"user_id": "37a4c183-8e33-43aa-8c0d-ea7bbc648bf1",

"valid?": true

}`

Password Connections

You can create or update Password connection preferences for an Organization (usualy your Enterprise customer).

The Password Connection type

Copy

`{"domain": "shark-academy",

"type": "PasswordConnection",

"active": true,

"id": "b6f3da01-b571-48c3-a630-6f1fddf5af31",

"inserted_at": "2023-06-08T13:47:41",

"pepper_rotation_period": 86400,

"plain_text_max_length": 40,

"plain_text_min_length": 8,

"updated_at": "2023-06-08T13:47:41"

}`

Headless Passwords

You can create, reset or renew a Password for an User.

The Headless Passwords type

Copy

`{"domain": "loirama",

"environment": "production",

"type": "Password",

"code": "DqwZQU8umrgLBAZXEPRiizjOCpzQJgTXwWya6dX3cXkpESDAgqcgTYKq0TPFeYt6MCv5l1pcg8ySB6FJmNhyA5WhHYyVlQXs2udx",

"id": 145,

"user_id": "9e6e2777-d2bb-42cb-bb7a-13139358d7fa"

}`

tag/Password/operation/create-password Create a new Password

Create a Password (Renew, Reset, First Creation). You can use this endpoint with a password_code or without it. The password_code is a code that we will send you to allow you to reset the password of the user. You will obtain this code by performing a Password Request or by processing a PasswordChallenge for which the password has expired. If you don't want to use the password_code. Don't include the key in your query.

RETURNS

A Struct giving data about the new password.

query Parameters

Responses

201

Created

422

UnprocessableEntity

post/api/v2/password

https://${{cryptr_service_url}}/api/v2/password

Request samples

• cURL

Copy

curl -X POST '${cryptr_service_url}/api/v2/renew-password' \
  -d user_email="lyla@loirama.co" \
  -d password_code="jf78Hgdz5d" \
  -d plain_text="neripe7845sjHgdeje!" \
  -d org_domain="communitiz-app"

Response samples

• 201
• 422

Content type

application/json

Copy

`{"domain": "loirama",

"environment": "production",

"type": "Password",

"code": "DqwZQU8umrgLBAZXEPRiizjOCpzQJgTXwWya6dX3cXkpESDAgqcgTYKq0TPFeYt6MCv5l1pcg8ySB6FJmNhyA5WhHYyVlQXs2udx",

"id": 145,

"user_id": "9e6e2777-d2bb-42cb-bb7a-13139358d7fa"

}`

tag/Password/operation/password-challenge Create a Password Challenge

Create a Password Challenge to strengthen security and simplify user authentication.

RETURNS

Returns information such as the request_id, renew_code, the validity, and other information associated with the Challenge created.

query Parameters

Responses

201

Created

404

Resource Not Found

post/api/v2/password-challenge

https://${{cryptr_service_url}}/api/v2/password-challenge

Request samples

• cURL

Copy

curl -X POST '${cryptr_service_url}/api/v2/password-challenge' \
  -d user_email="lyla@loirama.co" \

Response samples

• 201
• 404

Content type

application/json

Copy

`{"domain": "loirama",

"environment": "production",

"type": "PasswordChallenge",

"code": "iIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6NDAwMC90L2Jsb2NrcHVsc2UiLCJraWQ",

"error": null,

"expired_at": null,

"password_id": 145,

"renew_password": null,

"request_id": "edead972-68e1-49ea-8257-c0584cded957",

"user_id": "37a4c183-8e33-43aa-8c0d-ea7bbc648bf1",

"valid?": true

}`

tag/Password/operation/create-password-connection Create a Password Connection

Creates a new Password Connection. This will enable password login for users and allow you to configure it.

RETURNS

Returns a Password Connection if the creation succeed.

path Parameters

query Parameters

Responses

201

Created

422

Already exists

post/api/v2/org/{org_domain}/password-connection

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/password-connection

Request samples

• cURL

Copy

curl -X POST '${cryptr_service_url}/api/v2/org/${org_domain}/password-connection'

Response samples

• 201
• 422

Content type

application/json

Copy

`{"domain": "shark-academy",

"type": "PasswordConnection",

"active": true,

"id": "b6f3da01-b571-48c3-a630-6f1fddf5af31",

"inserted_at": "2023-06-08T13:47:41",

"pepper_rotation_period": 86400,

"plain_text_max_length": 40,

"plain_text_min_length": 8,

"updated_at": "2023-06-08T13:47:41"

}`

tag/Password/operation/password-request Request a new Password via Magic Link

Request a new Password. This endpoint is useful when the password is leaked, forgot or when you want to create the first password of the user.

RETURNS

A Struct giving data about the password Request. Including the Magic Link Token that you will have to send to the user to reset or create his password.

query Parameters

Responses

201

Requested

500

Internal Server Error

post/api/v2/password-request

https://${{cryptr_service_url}}/api/v2/password-request

Request samples

• cURL

Copy

curl -X POST '${cryptr_service_url}/api/v2/password-request' \
  -d user_email="lyla@loirama.co" \
  -d org_domain="communitiz-app" \
  -d redirect_uri="https://loirama.com/welcome-back-user"

Response samples

• 201
• 500

Content type

application/json

Copy

`{"domain": "loirama",

"environment": "production",

"type": "PasswordRequest",

"expired_at": "2023-05-04T07:16:56",

"magic_link": "http://loirama.com/password-request/verify/Ouha3JS4pv1OMX5kYsNJiFDD54lPP",

"redirect_uri": "https://loirama.com/welcome-back-user",

"request_id": "4db191b5-6209-4358-9d09-a28b8a8eaab5",

"user_id": "d6a46443-c7bc-4259-aa5d-ce51cc548b57"

}`

tag/Password/operation/read-one-password-connection Retrieve a Password Connection

Retrieve a Password Connection for an Organization by providing the org_domain. This request allowes you to obtain information about an existing Password Connection associated with the specified Organization.

RETURNS

If the reques is successful, the API returns an object representing the retrieved Password Connection

path Parameters

Responses

200

OK

get/api/v2/org/{org_domain}/password-connection

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/password-connection

Request samples

• cURL

Copy

curl '${cryptr_service_url}/api/v2/org/${org_domain}/password-connection'

Response samples

• 200

Content type

application/json

Copy

`{"domain": "shark-academy",

"type": "PasswordConnection",

"active": true,

"id": "b6f3da01-b571-48c3-a630-6f1fddf5af31",

"inserted_at": "2023-06-08T13:47:41",

"pepper_rotation_period": 86400,

"plain_text_max_length": 40,

"plain_text_min_length": 8,

"updated_at": "2023-06-08T13:47:41"

}`

tag/Password/operation/update-password-connection Update a Password Connection

path Parameters

query Parameters

Responses

200

OK

put/api/v2/org/{org_domain}/password-connection

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/password-connection

Request samples

• cURL

Copy

curl -X PUT '${cryptr_service_url}/api/v2/org/${org_domain}/password-connection' \
  -d active=false

Response samples

• 200

Content type

application/json

Copy

`{"domain": "shark-academy",

"type": "PasswordConnection",

"active": false,

"id": "b6f3da01-b571-48c3-a630-6f1fddf5af31",

"inserted_at": "2023-06-08T13:47:41",

"pepper_rotation_period": 86400,

"plain_text_max_length": 40,

"plain_text_min_length": 8,

"updated_at": "2023-06-08T13:47:41"

}`

tag/Magic-Link ✨ Magic Link

Magic Link Connection

Cryptr provides a secure solution for creating, managing, updating, and deleting connections using magic links. These magic links enable passwordless authentication, simplifying the login process while enhancing security.

Magic Link Connections can be set to specific organizations' environments, allowing user registration or restricting access to registered users. You can customize the magic link emails by providing template IDs for personalized sign-up experiences.

The Magic Link Connection type

Copy

`{"type": "string",

"active": true,

"find_or_create_user": false,

"id": null,

"inserted_at": "2019-08-24T14:15:22Z",

"sign_in_template_id": null,

"updated_at": "2019-08-24T14:15:22Z"

}`

The Magic Link Challenge type

Copy

`{"domain": "loirama",

"environment": "production",

"type": "MagicLinkChallenge",

"code": null,

"email_address": "random@gmail.com",

"find_or_create_user": true,

"magic_link": "https://my_uri.com/eyJhbGciOiJSUzI1NiIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6NDAwMC90L2NyeXB0ciIsImtpZCI6IjNmYzE2ODE2LTBmOTktNDg0Zi1iM2QxLTg3YzIyYWUxNWI5YyIsInR5cCI6IkpXVCJ9.eyJhdXRobj8iOmZhbHNlLCJjbGllbnRfaWQiOiJhOTMzYjc1My02NzA1LTQxZTQtYWUyNi1mOWRmNWFhMDVmMmMiLCJlbWFpbCI6InJhbmRvbUBnbWFpbC5jb20iLCJlbnZpcm9ubWVudCI6ImRlZmF1bHQiLCJleHBpcmVkX2F0IjoxNjkxMTg2Mzg5LCJmaW5kX29yX2NyZWF0ZV91c2VyIjp0cnVlLCJvcmdfZG9tYWluIjoiY3J5cHRyIiwicmVkaXJlY3RfdXJpIjoiaHR0cHM6Ly9yZWRpcmVjdF91cmkuY29tIiwicmVxdWVzdF9pZCI6IjRkMTZlZTk4LTdjZTctNDhiMS1hNGE4LTY4ZTJmY2Q3NmU2MyIsInVzZXJfaWQiOm51bGx9.xJ3cJ7KziquzQl5pdLvxDYp-oUGLcCrpETvwhBivh-IGjyk8LMunCeXJhR1gRLdD4PoYZcvRqwDP_oYKNM_xs033pXwVGdicmF3s3W81MJspKt5WDeHEr5Is7FulbRgWRZ0-sZRlvX-MWH4O9Bhdc5WzIOT56jyRqWZZxiOKtYCwsRpnGyUWv-PvmpCLFDBvHCRJ9Hy3hcrHG3vPLqjN4MjyOQsEdKiKVWbJgwG1w73YimOMCWec7mk4o1jMk_ApBtq_BK52kzI6zDdOLNaw-LSdREH60Psn2aCRJnGBCHfsiTqwN0Cnx6GHmxGr7FkmAm2sGmDVF4Ku82DcTQoM4-7gomSL7l83Mk86TA9uxHSy7saRB1a1UZ4ANrayhSZsDxRzT0kLRRx8oswRoRj5t_MsTbtLoB6UP0y7iWCZ7S5abDJ4cVvuOzAoiL_RH3i3CJtFIkKH2kCTVx1nyrbZb3-LSKYiydltAorML9i48v3SyW2XnB2Mone_fed3fkV3swM5lRkjkkYMFnWcvc7zVZFc_sXcutDbXA39svqrzFdpwBhJNEg8U-aJ57OoVoBb9WnNOdYYe9LxvtwHr2nUvjKt9YK67kefjJZDko8UFieMNLg8k72wa27gIwNt5lIIn1NnFZzsD98qvpzzqoHVizmYb8zLmzoUe1lQ5FK_5oo",

"request_id": null

}`

tag/Magic-Link/operation/magic-link-challenge Create a Magic Link Challenge

Create a Magic Link Challenge to simplify user authentication.

RETURNS

Returns information such as the email_address, the Magic Link, and other information associated with the Challenge created.

query Parameters

Responses

201

Created

404

Resource Not Found

post/api/v2/magic-link-challenge

https://${{cryptr_service_url}}/api/v2/magic-link-challenge

Request samples

• cURL

Copy

curl -X POST '${cryptr_service_url}/api/v2/magic-link-challenge' \
  -d user_email="lyla@loirama.co" \
  -d redirect_uri="https://loirama.com/welcome-back-user"

Response samples

• 201
• 404

Content type

application/json

Copy

`{"domain": "loirama",

"environment": "production",

"type": "MagicLinkChallenge",

"code": null,

"email_address": "random@gmail.com",

"find_or_create_user": true,

"magic_link": "https://my_uri.com/magic-link/verify/eyJhbGciOiJSUzI1NiIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6NDAwMC90L2NyeXB0ciIsImtpZCI6IjNmYzE2ODE2LTBmOTktNDg0Zi1iM2QxLTg3YzIyYWUxNWI5YyIsInR5cCI6IkpXVCJ9.eyJhdXRobj8iOmZhbHNlLCJjbGllbnRfaWQiOiJhOTMzYjc1My02NzA1LTQxZTQtYWUyNi1mOWRmNWFhMDVmMmMiLCJlbWFpbCI6InJhbmRvbUBnbWFpbC5jb20iLCJlbnZpcm9ubWVudCI6ImRlZmF1bHQiLCJleHBpcmVkX2F0IjoxNjkxMTg2Mzg5LCJmaW5kX29yX2NyZWF0ZV91c2VyIjp0cnVlLCJvcmdfZG9tYWluIjoiY3J5cHRyIiwicmVkaXJlY3RfdXJpIjoiaHR0cHM6Ly9yZWRpcmVjdF91cmkuY29tIiwicmVxdWVzdF9pZCI6IjRkMTZlZTk4LTdjZTctNDhiMS1hNGE4LTY4ZTJmY2Q3NmU2MyIsInVzZXJfaWQiOm51bGx9.xJ3cJ7KziquzQl5pdLvxDYp-oUGLcCrpETvwhBivh-IGjyk8LMunCeXJhR1gRLdD4PoYZcvRqwDP_oYKNM_xs033pXwVGdicmF3s3W81MJspKt5WDeHEr5Is7FulbRgWRZ0-sZRlvX-MWH4O9Bhdc5WzIOT56jyRqWZZxiOKtYCwsRpnGyUWv-PvmpCLFDBvHCRJ9Hy3hcrHG3vPLqjN4MjyOQsEdKiKVWbJgwG1w73YimOMCWec7mk4o1jMk_ApBtq_BK52kzI6zDdOLNaw-LSdREH60Psn2aCRJnGBCHfsiTqwN0Cnx6GHmxGr7FkmAm2sGmDVF4Ku82DcTQoM4-7gomSL7l83Mk86TA9uxHSy7saRB1a1UZ4ANrayhSZsDxRzT0kLRRx8oswRoRj5t_MsTbtLoB6UP0y7iWCZ7S5abDJ4cVvuOzAoiL_RH3i3CJtFIkKH2kCTVx1nyrbZb3-LSKYiydltAorML9i48v3SyW2XnB2Mone_fed3fkV3swM5lRkjkkYMFnWcvc7zVZFc_sXcutDbXA39svqrzFdpwBhJNEg8U-aJ57OoVoBb9WnNOdYYe9LxvtwHr2nUvjKt9YK67kefjJZDko8UFieMNLg8k72wa27gIwNt5lIIn1NnFZzsD98qvpzzqoHVizmYb8zLmzoUe1lQ5FK_5oo",

"request_id": null

}`

tag/Magic-Link/operation/read-one-magic-link-connection Retrieve a Magic Link Connection

Retrieve a Magic Link Connection for an Organization by providing the org_domain. This request allows you to obtain information about an existing Magic Link Connection associated with the specified organization.

RETURNS

If the request is successful, the API returns an object representing the retrieved Magic Link Connection.

path Parameters

Responses

200

OK

get/api/v2/org/{org_domain}/magic-link-connection

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/magic-link-connection

Request samples

• cURL

Copy

curl '${cryptr_service_url}/api/v2/org/${org_domain}/magic-link-connection'

Response samples

• 200

Content type

application/json

Copy

`{"type": "MagicLinkConnection",

"active": true,

"find_or_create_user": false,

"id": "b6f3da01-b571-48c3-a630-6f1fddf5af31",

"inserted_at": "2023-06-08T13:47:41",

"sign_in_template_id": "b653df01-b571-48c3-a630-6f1fddf5af31",

"updated_at": "2023-06-08T13:47:41"

}`

tag/Magic-Link/operation/update-magic-link-connection Update a Magic Link Connection

Update a Magic Link Connection for an Organization by providing the org_domain, and modify the find_or_create_user key to determine whether to automatically register users on their first login or restrict access to existing users.

RETURNS

If the request is successful, the API returns an updated MagicLinkConnection object, confirming the modifications made to the Magic Link Connection for the specified organization.

path Parameters

query Parameters

Responses

200

OK

put/api/v2/org/{org_domain}/magic-link-connection

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/magic-link-connection

Request samples

• cURL

Copy

curl -X PUT '${cryptr_service_url}/api/v2/org/${org_domain}/magic-link-connection' \
  -d find_or_create_user=${find_or_create_user} \
  -d active=${active} \

Response samples

• 200

Content type

application/json

Copy

`{"type": "MagicLinkConnection",

"active": true,

"find_or_create_user": false,

"id": "b6f3da01-b571-48c3-a630-6f1fddf5af31",

"inserted_at": "2023-06-08T13:47:41",

"sign_in_template_id": "b653df01-b571-48c3-a630-6f1fddf5af31",

"updated_at": "2023-06-08T13:47:41"

}`

tag/TOTP 🔑 TOTP

Headless TOTP Challenges

TOTP challenge is a secure validation process for TOTP. It involves an authentication request sent to the user, who must pass a challenge to prove their identity and access protected services.

The TOTP Challenge type

Copy

`{"type": "TotpChallenge",

"challenged_at": null,

"code": null,

"recovery_code_used": false,

"request_id": null,

"sent_at": null,

"success": true

}`

TOTP Connections

You can create or update TOTP connection preferences for an organization (usually your enterprise customer).

The TOTP Connection type

Copy

`{"domain": "loirama",

"active": true,

"expiry_in_seconds": 600,

"method": "sms"

}`

TOTP Enrollment

You can enroll your users in TOTP.

The TOTP Enrollment type

Copy

`{"domain": "loirama",

"environment": "production",

"type": "TotpEnrollment",

"email": "jean@loirama.com",

"enrolled_totp_at": "2023-08-23T09:32:42",

"enrollment_totp_nb": 1,

"first_verification_code": "935885",

"last_recovery_acknowledgement_at": null,

"last_recovery_code_at": null,

"recovery_codes": "b8JS-04VLtcY-5LVXqG_\nW9-9BnAwd2Wvt4928V1q\nZxB29DgffU7QiAAZp6-b\nrvUxePOaZIEM6U69-mpS\nsZqbtudhH9QmY_pepbkp",

"uri": null,

"validated_enrollment_at": null

}`

tag/TOTP/operation/create-totp-challenge Create a TOTP Challenge

Create a TOTP Challenge to enhance security, specifically useful for the SMS method to generate a code and send it to your users via SMS.

RETURNS

Returns information such as the request_id, code, validity, and other details associated with the created challenge.

path Parameters

Responses

201

Created

403

Forbidden

404

Resource Not Found

422

Unprocessable Entity

post/api/v2/org/{org_domain}/totp-challenge/{user_id}

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/totp-challenge/{user_id}

Request samples

• cURL

Copy

curl -X POST '${cryptr_service_url}/api/v2/org/${org_domain}/totp-challenge/:user_id'

Response samples

• 201
• 403
• 404
• 422

Content type

application/json

Copy

`{"type": "TotpChallenge",

"challenged_at": null,

"code": "044416",

"recovery_code_used": false,

"request_id": "totp-challenge_2ULQqKdMOFwJ0HJfR8rTt1f1kxv",

"sent_at": "2023-08-22T15:02:50.101028",

"success": false

}`

tag/TOTP/operation/create-totp-enrollment Create a TOTP Enrollment

Create a TOTP enrollment to register a user for MFA (TOTP).

RETURNS

Returns information such as enrollment_nb, enrolled_at, validity, and other details associated with the created enrollment.

path Parameters

Responses

201

Created

404

Resource Not Found

post/api/v2/org/{org_domain}/totp-enrollment/{user_id}

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/totp-enrollment/{user_id}

Request samples

• cURL

Copy

curl -X POST '${cryptr_service_url}/api/v2/org/${org_domain}/totp-enrollment/:user_id' \
-d force_enroll='false'

Response samples

• 201
• 404

Content type

application/json

Copy

`{"domain": "loirama",

"environment": "production",

"type": "TotpEnrollment",

"email": "jean@loirama.com",

"enrolled_totp_at": "2023-08-23T09:32:42",

"enrollment_totp_nb": 1,

"first_verification_code": "935885",

"last_recovery_acknowledgement_at": null,

"last_recovery_code_at": null,

"recovery_codes": "b8JS-04VLtcY-5LVXqG_\nW9-9BnAwd2Wvt4928V1q\nZxB29DgffU7QiAAZp6-b\nrvUxePOaZIEM6U69-mpS\nsZqbtudhH9QmY_pepbkp",

"uri": null,

"validated_enrollment_at": null

}`

tag/TOTP/operation/retrieve-totp-connection Retrieve a TOTP Connection

Retrieve a TOTP Connection for an Organization by specifying the org_domain. By default, organizations own a TOTP Connection, but it is deactivated.

RETURNS

If the request is successful, the API returns a TOTP object with an identifier including all the information associated with it.

path Parameters

Responses

200

OK

get/api/v2/org/{org_domain}/totp-connection

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/totp-connection

Request samples

• cURL

Copy

curl -X GET '${cryptr_service_url}/api/v2/org/${org_domain}/totp-connection

Response samples

• 200

Content type

application/json

Copy

`{"domain": "loirama",

"active": true,

"expiry_in_seconds": 600,

"method": "sms"

}`

tag/TOTP/operation/update-totp-connection Update a TOTP Connection

Update a TOTP Connection for an Organization by specifying the org_domain. By default, organizations own a TOTP Connection, but it is deactivated.

RETURNS

If the request is successful, the API returns a TOTP object with an identifier including all the information entered.

path Parameters

query Parameters

Responses

201

Updated

422

Unprocessable Entity

put/api/v2/org/{org_domain}/totp-connection

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/totp-connection

Request samples

• cURL

Copy

curl -X POST '${cryptr_service_url}/api/v2/org/${org_domain}/totp-connection' \
  -d active='true' \
  -d expiry_in_seconds='30' \
  -d method='totp_mobile_app'

Response samples

• 201
• 422

Content type

application/json

Copy

`{"domain": "loirama",

"active": true,

"expiry_in_seconds": 600,

"method": "sms"

}`

tag/TOTP/operation/validate-totp-challenge Validate a TOTP Challenge

Validate a TOTP Challenge by checking the code the user enters on your app.

RETURNS

Returns information such as the request_id, code, the validity, and other information associated with the Challenge.

path Parameters

query Parameters

Responses

201

Created

401

Unauthorized

403

Forbidden

404

Resource Not Found

422

Unprocessable Entity

put/api/v2/org/{org_domain}/totp-challenge/validation/{user_id}

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/totp-challenge/validation/{user_id}

Request samples

• cURL

Copy

curl -X PUT '${cryptr_service_url}/api/v2/org/${org_domain}/totp-challenge/validation/:user_id' \
  -d code='478562'

Response samples

• 201
• 401
• 403
• 404
• 422

Content type

application/json

Copy

`{"type": "TotpChallenge",

"challenged_at": "2023-08-22T15:00:55.816432",

"code": "008029",

"recovery_code_used": false,

"request_id": "totp-challenge_2ULQbzNww3R4ANIZyroXwYsS8Wg",

"sent_at": null,

"success": true

}`

tag/TOTP/operation/validate-totp-enrollment Validate a TOTP Enrollment

Validate a TOTP enrollment by checking the code the user enters in your app. If the user is able to enter a valid code, we assume that they have registered their QR Code in their TOTP application or that their phone number is valid.

RETURNS

Returns information such as the enrollment_nb, enrolled_at, the validity, and other information associated with the enrollment.

path Parameters

query Parameters

Responses

200

OK

401

Unauthorized

404

Resource Not Found

put/api/v2/org/{org_domain}/totp-enrollment/validation/{user_id}

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/totp-enrollment/validation/{user_id}

Request samples

• cURL

Copy

curl -X PUT '${cryptr_service_url}/api/v2/org/${org_domain}/totp-enrollment/validation/:user_id' \
  -d code='478562'

Response samples

• 200
• 401
• 404

Content type

application/json

Copy

`{"domain": "loirama",

"environment": "production",

"type": "TotpEnrollment",

"email": "jean@loirama.com",

"enrolled_totp_at": "2023-08-23T09:32:42",

"enrollment_totp_nb": 1,

"first_verification_code": null,

"last_recovery_acknowledgement_at": null,

"last_recovery_code_at": null,

"recovery_codes": "b8JS-04VLtcY-5LVXqG_\nW9-9BnAwd2Wvt4928V1q\nZxB29DgffU7QiAAZp6-b\nrvUxePOaZIEM6U69-mpS\nsZqbtudhH9QmY_pepbkp",

"uri": null,

"validated_enrollment_at": "2023-08-23T09:34:50"

}`

tag/Admin ⚙️ Admin

The Admin type

When you have the email contact of the SSO manager of the organization you want to work with, an Admin can be created. This Admin will be able to configure the SSO on their side by accessing the Onboarding.

Once created, the Admin will directly receive a magic link email to their onboarding.

Copy Expand all Collapse all

`{"accepted_invitation_at": null,

"color": "red-500",

"declined_to_be_in_charge_at": null,

"email": "it_sso_person@sso.client.com",

"id": "64a13b92-e635-4931-a96f-5312fe3ba418",

"inserted_at": "2023-06-09T16:22:44",

"invited_at": "2023-06-09T16:22:44",

"last_login_at": null,

"organization": {"type": "Organization",

"allowed_email_domains": ["barker.co"

],

"domain": "barker-inc",

"environments": [{"name": "production",

"status": "down"

},

{"name": "sandbox",

"status": "up"

}

],

"inserted_at": "2023-06-08T12:12:28",

"name": "Barker",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"updated_at": "2023-06-08T12:37:59"

},

"updated_at": "2023-06-09T16:22:44"

}`

tag/Admin/operation/create-admin Create the Admin

See the Admin type for more information about the fields and their values you receive in the response.

An invitation link with a long TTL is sent to the Admin by email upon creation.

RETURNS

The created Admin with proper attributes

path Parameters

query Parameters

Responses

201

Created

401

Unauthorized

post/api/v2/org/{org_domain}/admins

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/admins

Request samples

• cURL

Copy

curl -X POST ${cryptr_service_url}/api/v2/org/${org_domain}/admins

Response samples

• 201
• 401

Content type

application/json

Copy Expand all Collapse all

`{"accepted_invitation_at": null,

"color": "red-500",

"declined_to_be_in_charge_at": null,

"email": "it_sso_person@sso.client.com",

"id": "64a13b92-e635-4931-a96f-5312fe3ba418",

"inserted_at": "2023-06-09T16:22:44",

"invited_at": "2023-06-09T16:22:44",

"last_login_at": null,

"organization": {"type": "Organization",

"allowed_email_domains": ["barker.co"

],

"domain": "barker-inc",

"environments": [{"name": "production",

"status": "down"

},

{"name": "sandbox",

"status": "up"

}

],

"inserted_at": "2023-06-08T12:12:28",

"name": "Barker",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"updated_at": "2023-06-08T12:37:59"

},

"updated_at": "2023-06-09T16:22:44"

}`

tag/Admin/operation/delete-admin Delete an Admin

Delete an Admin by its organization domain and email. The domain is generated from its organization’s name. It’s a unique and immutable value in your Cryptr service.

RETURNS

Returns the deleted Admin for a valid identifier and email.

path Parameters

Responses

200

OK

401

Unauthorized

404

Not Found

delete/api/v2/org/{org_domain}/admins/{email}

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/admins/{email}

Request samples

• cURL

Copy

curl -X DELETE '${cryptr_service_url}/api/v2/org/${org_domain}/admins/${email}'

Response samples

• 200
• 401
• 404

Content type

application/json

Copy Expand all Collapse all

`{"deleted": true,

"resource": {"accepted_invitation_at": null,

"color": "red-500",

"declined_to_be_in_charge_at": null,

"email": "it_sso_person@sso.client.com",

"id": "64a13b92-e635-4931-a96f-5312fe3ba418",

"inserted_at": "2023-06-09T16:22:44",

"invited_at": "2023-06-09T16:22:44",

"last_login_at": null,

"organization": {"type": "Organization",

"allowed_email_domains": ["barker.co"

],

"domain": "barker-inc",

"environments": [{"name": "production",

"status": "down"

},

{"name": "sandbox",

"status": "up"

}

],

"inserted_at": "2023-06-08T12:12:28",

"name": "Barker",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"updated_at": "2023-06-08T12:37:59"

},

"updated_at": "2023-06-09T16:22:44"

}

}`

tag/Admin/operation/list-admins List all Admins

Returns a list of your Admins. The Admins are returned sorted by creation date, with the most recent appearing first.

RETURNS

A dictionary with a data property that contains an array of up to limit Admins. Each entry in the array is a separate Admin type. If no Admins are available, the resulting array will be empty. This request should never return an error.

path Parameters

query Parameters

Responses

200

OK

401

Unauthorized

get/api/v2/org/{org_domain}/admins

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/admins

Request samples

• cURL

Copy

curl 'https://${cryptr_service_url}/api/v2/org/${org_domain}/admins' \
  -d page=${page}
  -d per_page=${per_page}

Response samples

• 200
• 401

Content type

application/json

Copy Expand all Collapse all

`{"type": "List",

"data": [{"accepted_invitation_at": null,

"color": "red-500",

"declined_to_be_in_charge_at": null,

"email": "it_sso_person@sso.client.com",

"id": "64a13b92-e635-4931-a96f-5312fe3ba418",

"inserted_at": "2023-06-09T16:22:44",

"invited_at": "2023-06-09T16:22:44",

"last_login_at": null,

"organization": {"type": "Organization",

"allowed_email_domains": ["barker.co"

],

"domain": "barker-inc",

"environments": [{"name": "production",

"status": "down"

},

{"name": "sandbox",

"status": "up"

}

],

"inserted_at": "2023-06-08T12:12:28",

"name": "Barker",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"updated_at": "2023-06-08T12:37:59"

},

"updated_at": "2023-06-09T16:22:44"

}

],

"pagination": {"current_page": 1,

"current_pages": [1,

2,

3,

"...",

6

],

"next_page": 2,

"per_page": 2,

"prev_page": null,

"total_pages": 6

},

"total": 11

}`

tag/Admin/operation/retrieve-admin Retrieve an Admin

Fetch an Admin by its organization domain and email. The domain is generated from its organization’s name. It’s a unique and immutable value in your Cryptr service.

RETURNS

Returns the Admin for a valid identifier and email.

path Parameters

Responses

200

OK

401

Unauthorized

404

Not Found

get/api/v2/org/{org_domain}/admins/{email}

https://${{cryptr_service_url}}/api/v2/org/{org_domain}/admins/{email}

Request samples

• cURL

Copy

curl '${cryptr_service_url}/api/v2/org/${org_domain}/admins/${email}'

Response samples

• 200
• 401
• 404

Content type

application/json

Copy Expand all Collapse all

`{"accepted_invitation_at": null,

"color": "red-500",

"declined_to_be_in_charge_at": null,

"email": "it_sso_person@sso.client.com",

"id": "64a13b92-e635-4931-a96f-5312fe3ba418",

"inserted_at": "2023-06-09T16:22:44",

"invited_at": "2023-06-09T16:22:44",

"last_login_at": null,

"organization": {"type": "Organization",

"allowed_email_domains": ["barker.co"

],

"domain": "barker-inc",

"environments": [{"name": "production",

"status": "down"

},

{"name": "sandbox",

"status": "up"

}

],

"inserted_at": "2023-06-08T12:12:28",

"name": "Barker",

"status": {"errors": [ ],

"estimated_time_to_complete_in_seconds": null,

"progress_in_percentage": null,

"state": "pending"

},

"updated_at": "2023-06-08T12:37:59"

},

"updated_at": "2023-06-09T16:22:44"

}`

tag/Webhook-Setup 🔄 Webhook Setup

The Webhook in Cryptr allows you to stay informed about activities happening on your App or Directory Sync.

For example, if a user is created, the change will be automatically reflected, and the details will be sent to your target URL. Several actions are supported, including updating, deleting, or creating resources.

The Webhook type

You can create one or more Webhooks for each organization domain and environment pair. For example, if your organization's domain is "misapret" and you have a "sandbox" environment, you can create a Webhook for "misapret/sandbox". However, if you also have a "production" environment, you will only receive information from your "sandbox" environment. To receive information from your "production" environment as well, you will need to create an additional webhook.

Copy Expand all Collapse all

`{"environment": "sandbox",

"type": "Webhook",

"active": true,

"event_codes": ["dir_sync.user.provision.success"

],

"id": "webhook_2RCVpicx8L7cFwhrz2gHjnsCLKQ",

"inserted_at": "2023-06-14T14:50:34",

"name": "My Webhook Name",

"signature_key": "Rjyhf8JcIfPtUhagKRKsu2Delq0JR3z6huEuJJLUwTaK8U380sA1tEgY_4aJYaRNbh_s2-u5_IWbrWQBV_DiDWAX1XNEV6DHDV8cvYGo00PkA32yWrwgEEG9ajbQ-IIT",

"target_url": "http://webhook.site",

"updated_at": "2023-06-14T14:50:34"

}`

tag/Webhook-Setup/operation/create-webhook Create a Webhook

Creates a new Webhook for your organization. When you create a Webhook, you will receive the associated signature key.

Note: When you create a Webhook, its storage location is determined by the environment of your API key. For example, a Webhook is created in the sandbox environment only if the corresponding resource is stored in the sandbox. You cannot create a Webhook in the Production environment with this API key; you need an API key dedicated to that environment.

query Parameters

Responses

201

Created

422

Unprocessable Entity

post/api/v2/webhooks

https://${{cryptr_service_url}}/api/v2/webhooks

Request samples

• cURL

Copy

curl -X POST '${cryptr_service_url}/api/v2/webhooks' \
  -d 'name=New Webhook' \
  -d 'target_url=https://webhook.site' \
  -d 'event_codes=dir_sync.user.provision.success'

Response samples

• 201
• 422

Content type

application/json

Copy Expand all Collapse all

`{"environment": "sandbox",

"type": "Webhook",

"active": true,

"event_codes": ["dir_sync.user.provision.success"

],

"id": "webhook_2RCVpicx8L7cFwhrz2gHjnsCLKQ",

"inserted_at": "2023-06-14T14:50:34",

"name": "My Webhook Name",

"signature_key": "Rjyhf8JcIfPtUhagKRKsu2Delq0JR3z6huEuJJLUwTaK8U380sA1tEgY_4aJYaRNbh_s2-u5_IWbrWQBV_DiDWAX1XNEV6DHDV8cvYGo00PkA32yWrwgEEG9ajbQ-IIT",

"target_url": "http://webhook.site",

"updated_at": "2023-06-14T14:50:34"

}`

tag/Webhook-Setup/operation/delete-webhook Delete a Webhook

Use the request below when you want to delete a Webhook.

RETURNS

The deleted Webhook

path Parameters

Responses

200

OK

404

Not Found

delete/api/v2/webhooks/{id}

https://${{cryptr_service_url}}/api/v2/webhooks/{id}

Request samples

• cURL

Copy

curl -X DELETE '${cryptr_service_url}/api/v2/webhooks/${id}'

Response samples

• 200
• 404

Content type

application/json

Copy Expand all Collapse all

`{"deleted": true,

"resource": {"environment": "sandbox",

"type": "Webhook",

"active": true,

"event_codes": ["dir_sync.user.provision.success"

],

"id": "webhook_2RCVpicx8L7cFwhrz2gHjnsCLKQ",

"inserted_at": "2023-06-14T14:50:34",

"name": "My Webhook Name",

"signature_key": "Rjyhf8JcIfPtUhagKRKsu2Delq0JR3z6huEuJJLUwTaK8U380sA1tEgY_4aJYaRNbh_s2-u5_IWbrWQBV_DiDWAX1XNEV6DHDV8cvYGo00PkA32yWrwgEEG9ajbQ-IIT",

"target_url": "http://webhook.site",

"updated_at": "2023-06-14T14:50:34"

}

}`

tag/Webhook-Setup/operation/list-webhooks List all Webhooks

Retrieve all your organization’s Webhooks using pagination or not.

Note: When you fetch the Webhooks, the environment of your API key determines where your Webhooks are stored. For example, your Webhooks in the sandbox are fetched only if the resources are stored in the sandbox. You can’t fetch Webhooks from the Production environment with this API key; you need an API key dedicated to this environment.

RETURNS

Returns a list of Webhooks for a valid organization/environment pair. If no Webhooks exist, an empty list is displayed.

query Parameters

Responses

200

OK

get/api/v2/webhooks

https://${{cryptr_service_url}}/api/v2/webhooks

Request samples

• cURL

Copy

curl '${cryptr_service_url}/api/v2/webhooks' \
  -d "page=${page}" \
  -d "per_page=${per_page}" \

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"type": "List",

"data": [{"environment": "sandbox",

"type": "Webhook",

"active": true,

"event_codes": ["dir_sync.user.provision.success"

],

"id": "webhook_2REPA0hJihspyjNTrfeLZYrOYS2",

"inserted_at": "2023-06-15T06:55:19",

"name": "My Webhook Name",

"signature_key": "VmL3Gsslj_IWyM4KYmpBYF1URbyHWdOMrogPjD0-yN1nrRPIyPlfr3U-Jv-jonQwRgYkJ6io4a-P_tycQ1ci9ZIfCzACvVNQQYBQzULQ9RPrO7XhMuYGK07XrqHWU2jS",

"target_url": "http://webhook.site",\
"updated_at": "2023-06-15T06:55:19"

},

{"environment": "sandbox",

"type": "Webhook",

"active": true,

"event_codes": ["dir_sync.activate.success",

"dir_sync.deactivate.success"

],

"id": "webhook_2RCVuHlyhadTW8IJfrbjU2KW4G1",

"inserted_at": "2023-06-14T14:51:10",

"name": "Super Webhook",

"signature_key": "4qmmFSOoZQLhlhV50bkNgp0SZt9EpNApUAToYLlFpgRYI-eJ7XHb9KDTuVtEhf7VKSb-0mySqUNRxo54IZ7hj-UxNP6RboQt4sUh0A-Rnt8rD6ERhDRG2Tzhl5V-q1h7",

"target_url": "https://www.cryptr.co",\
"updated_at": "2023-06-14T14:51:10"

},

{"environment": "sandbox",

"type": "Webhook",

"active": true,

"event_codes": ["sso_saml.user.jit_provision.success",

"sso_saml.user.update.success"

],

"id": "webhook_2RCTwiofROfxs3NTkx5BpsmwTUg",

"inserted_at": "2023-06-14T14:35:03",

"name": "Super Webhook",

"signature_key": "sTyVwG3b3A_01bhzQolwtxiDce1DAwm_lz_6BBLBouxvjCZBykJmVa2pDmcOkAjkgJkrXvM9lhVo2bI9cctUqXN7QMWkfcU6LgqZKgUMJ2onA-ccA2CjJw_a2zIXGtqU",

"target_url": "https://www.cryptr.co",\
"updated_at": "2023-06-14T14:35:03"

}

],

"pagination": {"current_page": 1,

"current_pages": [1,

2,

3,

"...",

6

],

"next_page": 2,

"per_page": 3,

"prev_page": null,

"total_pages": 6

},

"total": 16

}`

tag/Webhook-Setup/operation/retrieve-webhook Retrieve a Webhook

Retrieve Webhook information for your organization using its identifier.

Note: When you fetch a Webhook, the environment of your API key determines where your Webhook is stored. For example, your Webhook in the sandbox is fetched only if this resource is stored in the sandbox. You can't fetch a Webhook from the Production environment with this API key; you need an API key dedicated to that environment.

RETURNS

Returns the Webhook for a valid organization/environment pair. If it’s for a deleted Webhook, a Not Found response is displayed.

path Parameters

Responses

200

OK

404

Not Found

get/api/v2/webhooks/{id}

https://${{cryptr_service_url}}/api/v2/webhooks/{id}

Request samples

• cURL

Copy

curl '${cryptr_service_url}/api/v2/webhooks/${id}'

Response samples

• 200
• 404

Content type

application/json

Copy Expand all Collapse all

`{"environment": "sandbox",

"type": "Webhook",

"active": true,

"event_codes": ["dir_sync.user.provision.success"

],

"id": "webhook_2RCVpicx8L7cFwhrz2gHjnsCLKQ",

"inserted_at": "2023-06-14T14:50:34",

"name": "My Webhook Name",

"signature_key": "Rjyhf8JcIfPtUhagKRKsu2Delq0JR3z6huEuJJLUwTaK8U380sA1tEgY_4aJYaRNbh_s2-u5_IWbrWQBV_DiDWAX1XNEV6DHDV8cvYGo00PkA32yWrwgEEG9ajbQ-IIT",

"target_url": "http://webhook.site",

"updated_at": "2023-06-14T14:50:34"

}`

tag/Webhook-Setup/operation/update-webhook Update a Webhook

Update an existing Webhook for your Organization. You can only update the event_codes and the target_url. For example, if your previous target_url has changed since the webhook was created.

RETURNS

Returns the updated Webhook for a valid organization/environment pair. If not found, a 404 Not Found response is displayed.

path Parameters

query Parameters

Responses

200

OK

404

Not Found

put/api/v2/webhooks/{id}

https://${{cryptr_service_url}}/api/v2/webhooks/{id}

Request samples

• cURL

Copy

curl -X PUT '${cryptr_service_url}/api/v2/webhooks/${id}' \
  -d "event_codes[]=sso_saml.user.jit_provision.success" \
  -d "target_url=http://webhook.site" \
  -d "name=My Webhook Name"

Response samples

• 200
• 404

Content type

application/json

Copy Expand all Collapse all

`{"environment": "sandbox",

"type": "Webhook",

"active": true,

"event_codes": ["dir_sync.user.provision.success"

],

"id": "webhook_2RCVpicx8L7cFwhrz2gHjnsCLKQ",

"inserted_at": "2023-06-14T14:50:34",

"name": "My Webhook Name",

"signature_key": "Rjyhf8JcIfPtUhagKRKsu2Delq0JR3z6huEuJJLUwTaK8U380sA1tEgY_4aJYaRNbh_s2-u5_IWbrWQBV_DiDWAX1XNEV6DHDV8cvYGo00PkA32yWrwgEEG9ajbQ-IIT",

"target_url": "http://webhook.site",

"updated_at": "2023-06-14T14:50:34"

}`

tag/Webhook-Events 📊 Webhook Events

The Webhook Event type

Copy Expand all Collapse all

`{"type": "WebhookEvent",

"args": {"domain": "shark-academy",

"environment": "sandbox",

"type": "Event",

"code": "dir_sync.activate.success",

"data": {"type": "DirectorySyncEvent",

"directory_sync_id": "f71c2961-ebbd-4364-a6bd-e585614b9458",

"provider": "okta"

},

"issued_at": "2023-06-13T08:57:59.617402Z",

"webhook_id": "webhook_2QbwnDHL6z4TsohFvzOoE74NBvJ"

},

"attempt": 1,

"attempted_at": "2023-06-13T08:57:59.632125Z",

"cancelled_at": null,

"completed_at": "2023-06-13T08:57:59.761073Z",

"discarded_at": null,

"id": 80,

"inserted_at": "2023-06-13T08:57:59.621406Z",

"max_attempts": 5,

"scheduled_at": "2023-06-13T08:57:59.621406Z",

"state": "completed"

}`

tag/Webhook-Events/operation/cancel-webhook-events Cancel Webhook Event

Returns the canceled job when we have taken into account your request for a cancel. If not, you will receive an error message.

Note: When a cancel request is successful, the status of your Webhook Event should change to 'canceled.'

RETURNS

The canceled job. If the Webhook Events you requested to cancel don’t exist or if an error occurred, an error message will be sent.

path Parameters

Responses

200

OK

404

Not Found

post/api/v2/webhook-events/{id}/cancel

https://${{cryptr_service_url}}/api/v2/webhook-events/{id}/cancel

Request samples

• cURL

Copy

curl -X POST '${cryptr_service_url}/api/v2/webhook-events/${id}/cancel'

Response samples

• 200
• 404

Content type

application/json

Copy Expand all Collapse all

`{"type": "WebhookEvent",

"args": {"domain": "shark-academy",

"environment": "sandbox",

"type": "Event",

"code": "dir_sync.activate.success",

"data": {"domain": "shark-academy",

"type": "DirectorySyncEvent",

"change": "create",

"directory_sync_id": "14630346-0cd3-4cc6-8f88-9ca27e3f60fe",

"provider": "okta",

"resource": {"changes": {"new_values": {"domain": "shark-academy",

"environment": "sandbox",

"type": "User",

"address": {"country": "BE",

"formatted": "3 Heathcote Mall\n44843 New Fabiola, Belgium",

"locality": "New Fabiola",

"postal_code": "44843",

"region": "Florida",

"street_address": "3 Heathcote Mall"

},

"email": "madilyn.blanda@gutmann.com",

"email_verified": false,

"id": "bcee32ef-475a-4ada-8b58-a0cc516a3b7d",

"inserted_at": "2023-06-13T13:14:22",

"meta_data": [ ],

"phone_number": null,

"phone_number_verified": false,

"profile": {"birthdate": "1970-08-18",

"family_name": "Blanchet",

"gender": null,

"given_name": "Estelle",

"locale": "en_US",

"nickname": "Ginette",

"picture": "https://robohash.org/set_set1/bgset_bg2/yUwVdc0f",

"preferred_username": "kiley.gleason",

"website": "https://mayer.biz",

"zoneinfo": "America/Chicago"

},

"updated_at": "2023-06-13T13:14:22"

},

"previous_values": null

},

"id": "user_c8fcaf9d-fcbf-4b6f-a37f-70ec75d1a144",

"type": "User"

}

},

"issued_at": "2023-06-13T09:03:18.750478Z",

"webhook_id": "webhook_2QbwnDHL6z4TsohFvzOoE74NBvJ"

},

"attempt": 1,

"attempted_at": "2023-06-13T09:03:18.819155Z",

"cancelled_at": "2023-06-15T15:17:33.666466Z",

"completed_at": "2023-06-13T09:03:18.920373Z",

"discarded_at": null,

"id": 81,

"inserted_at": "2023-06-13T09:03:18.754610Z",

"max_attempts": 5,

"scheduled_at": "2023-06-13T09:03:18.754610Z",

"state": "cancelled"

}`

tag/Webhook-Events/operation/list-webhook-events List Webhook Events

The Webhook Events are returned sorted by issued date, with the most recent issued events appearing first.

Note: Webhook Events have a 24-hour lifespan. After this period, they are deleted unless their state is available, scheduled, executing or retryable.

RETURNS

Returns a list of your Webhook Events.

query Parameters

Responses

200

OK

get/api/v2/webhook-events

https://${{cryptr_service_url}}/api/v2/webhook-events

Request samples

• cURL

Copy

curl '${cryptr_service_url}/api/v2/webhook-events'
  -d "page=${page}" \
  -d "per_page=${per_page}" \

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"type": "List",

"data": [{"type": "WebhookEvent",

"args": {"domain": "follow-the-market",

"environment": "production",

"type": "Event",

"code": "dir_sync.user.create.success",

"data": {"domain": "shark-academy",

"type": "DirectorySyncEvent",

"change": "create",

"directory_sync_id": "14630346-0cd3-4cc6-8f88-9ca27e3f60fe",

"provider": "okta",

"resource": {"changes": {"new_values": {"domain": "shark-academy",

"environment": "sandbox",

"type": "User",

"address": {"country": "BE",

"formatted": "3 Heathcote Mall\n44843 New Fabiola, Belgium",

"locality": "New Fabiola",

"postal_code": "44843",

"region": "Florida",

"street_address": "3 Heathcote Mall"

},

"email": "madilyn.blanda@gutmann.com",

"email_verified": false,

"id": "bcee32ef-475a-4ada-8b58-a0cc516a3b7d",

"inserted_at": "2023-06-13T13:14:22",

"meta_data": [ ],

"phone_number": null,

"phone_number_verified": false,

"profile": {"birthdate": "1970-08-18",

"family_name": "Blanchet",

"gender": null,

"given_name": "Estelle",

"locale": "en_US",

"nickname": "Ginette",

"picture": "https://robohash.org/set_set1/bgset_bg2/yUwVdc0f",\
"preferred_username": "kiley.gleason",

"website": "https://mayer.biz",\
"zoneinfo": "America/Chicago"

},

"updated_at": "2023-06-13T13:14:22"

},

"previous_values": null

},

"id": "user_c8fcaf9d-fcbf-4b6f-a37f-70ec75d1a144",

"type": "User"

}

},

"issued_at": "U[2023-05-17 10:38:13.339032Z]",

"webhook_id": "webhook_id"

},

"attempt": 1,

"attempted_at": "U[2023-05-17 10:38:13.447032Z]",

"attempted_by": null,

"cancelled_at": null,

"completed_at": "U[2023-05-17 10:38:13.449032Z]",

"discarded_at": null,

"inserted_at": "U[2023-05-17 10:38:13.439032Z]",

"max_attempts": 5,

"scheduled_at": "~U[2023-05-17 10:38:17.000000Z]",

"state": "scheduled"

}

],

"pagination": {"current_page": 1,

"current_pages": [1

],

"next_page": null,

"per_page": 10,

"prev_page": null,

"total_pages": 1

},

"total": 1

}`

tag/Webhook-Events/operation/retry-webhook-events Retry Webhook Event

Returns the job for which you requested a retry once we have considered your request. Otherwise, you will receive an error message.

Note: When a retry request is successful the status of your Webhook Event should change to 'available'.

RETURNS

The job to be retried. If the Webhook Events you requested for retry do not exist or if an error occurs, an error message will be sent.

path Parameters

Responses

200

OK

404

Not Found

post/api/v2/webhook-events/{id}/retry

https://${{cryptr_service_url}}/api/v2/webhook-events/{id}/retry

Request samples

• cURL

Copy

curl -X POST '${cryptr_service_url}/api/v2/webhook-events/${id}/retry'

Response samples

• 200
• 404

Content type

application/json

Copy Expand all Collapse all

`{"type": "WebhookEvent",

"args": {"domain": "shark-academy",

"environment": "sandbox",

"type": "Event",

"code": "dir_sync.activate.success",

"data": {"domain": "shark-academy",

"type": "DirectorySyncEvent",

"change": "create",

"directory_sync_id": "14630346-0cd3-4cc6-8f88-9ca27e3f60fe",

"provider": "okta",

"resource": {"changes": {"new_values": {"domain": "shark-academy",

"environment": "sandbox",

"type": "User",

"address": {"country": "BE",

"formatted": "3 Heathcote Mall\n44843 New Fabiola, Belgium",

"locality": "New Fabiola",

"postal_code": "44843",

"region": "Florida",

"street_address": "3 Heathcote Mall"

},

"email": "madilyn.blanda@gutmann.com",

"email_verified": false,

"id": "bcee32ef-475a-4ada-8b58-a0cc516a3b7d",

"inserted_at": "2023-06-13T13:14:22",

"meta_data": [ ],

"phone_number": null,

"phone_number_verified": false,

"profile": {"birthdate": "1970-08-18",

"family_name": "Blanchet",

"gender": null,

"given_name": "Estelle",

"locale": "en_US",

"nickname": "Ginette",

"picture": "https://robohash.org/set_set1/bgset_bg2/yUwVdc0f",

"preferred_username": "kiley.gleason",

"website": "https://mayer.biz",

"zoneinfo": "America/Chicago"

},

"updated_at": "2023-06-13T13:14:22"

},

"previous_values": null

},

"id": "user_c8fcaf9d-fcbf-4b6f-a37f-70ec75d1a144",

"type": "User"

}

},

"issued_at": "2023-06-13T09:03:18.750478Z",

"webhook_id": "webhook_2QbwnDHL6z4TsohFvzOoE74NBvJ"

},

"attempt": 1,

"attempted_at": "2023-06-13T09:03:18.819155Z",

"cancelled_at": null,

"completed_at": "2023-06-13T09:03:18.920373Z",

"discarded_at": null,

"id": 81,

"inserted_at": "2023-06-13T09:03:18.754610Z",

"max_attempts": 5,

"scheduled_at": "2023-06-13T09:03:18.754610Z",

"state": "available"

}`

tag/Webhook-Events/operation/test-webhook-events Test Webhook Event

Returns the payload of the event you should receive for a particular event_code if your webhook is well configured.

Note: Not all event codes are available for testing.

RETURNS

The preview of the event you should receive. If no webhook is linked to this event_code, the preview will be nil, along with two lists of triggered and non-triggered webhooks.

query Parameters

Responses

200

OK

post/api/v2/webhook-events/trigger-test

https://${{cryptr_service_url}}/api/v2/webhook-events/trigger-test

Request samples

• cURL

Copy

curl -X POST '${cryptr_service_url}/api/v2/webhook-events/trigger-test'             --header 'Authorization: Bearer your_api_key_generated_token' \
    --header 'Content-Type: application/json' \
    -d event_code="dir_sync.user.update.success"

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"type": "WebhookEventTest",

"preview": {"domain": "shark-academy",

"environment": "sandbox",

"type": "Event",

"code": "dir_sync.user.provision.success",

"data": {"domain": "shark-academy",

"type": "DirectorySyncEvent",

"change": "create",

"directory_sync_id": "70b4ee66-4d2d-45ed-b351-292727ba0050",

"provider": "okta",

"resource": {"changes": {"new_values": {"domain": "shark-academy",

"environment": "sandbox",

"type": "User",

"address": {"country": "FR",

"formatted": "0465 Lelah Fields\n78361 Kshlerin, France",

"locality": "Kshlerin",

"postal_code": "78361",

"region": "New Hampshire",

"street_address": "0465 Lelah Fields"

},

"email": "reymundo2060@spencer.biz",

"email_verified": false,

"id": "7862c0ce-2c3d-4045-95f1-d1fb942b71a0",

"inserted_at": "2023-06-13T13:14:22",

"meta_data": [ ],

"phone_number": null,

"phone_number_verified": false,

"profile": {"birthdate": "1929-07-20",

"family_name": "Vernier",

"gender": null,

"given_name": "Pierre",

"locale": "fr_FR",

"nickname": "Victor",

"picture": "https://robohash.org/set_set3/bgset_bg1/n86s5A6H9Bn",

"preferred_username": "sienna2028",

"website": "http://kessler.net",

"zoneinfo": "America/Chicago"

},

"updated_at": "2023-06-13T13:14:22"

},

"previous_values": null

},

"id": "user_2771734b-4d4a-46c5-bd08-56ef6a3089a0",

"type": "User"

}

},

"issued_at": "2023-06-27T09:37:03.745212Z",

"webhook_id": "webhook_2RmcDyFCS3jOwaGNh0NufCrpbBD"

},

"triggered_webhooks": [{"environment": "sandbox",

"type": "Webhook",

"active": true,

"event_codes": ["dir_sync.user.provision.success"

],

"id": "webhook_2RmcDyFCS3jOwaGNh0NufCrpbBD",

"inserted_at": "2023-06-27T09:36:20",

"name": "My Webhook Name",

"signature_key": "6H0dAygazkUpiJJe_oMajpNVuFz6QvkSVHYvYzLCArqiOFWXTwaVJFFBOk1xBOg0vX81TKTtW4Md48KJ_ah3SQRUt0W8J1a_ayXTA4tX-srnMDPRzzkNablSms7pVqp4",

"target_url": "http://webhook.site",\
"updated_at": "2023-06-27T09:36:20"

}

],

"untriggered_webhooks": [ ]

}`

tag/RedirectUris 🔂 Redirect URIs

After a successful end-user authentication, they will be redirected to one of its allowed environment Redirect URIs.

The Redirect URI type

Copy

`{"environment": "sandbox",

"type": "RedirectUri",

"default": false,

"id": "20c8da6b-8086-45f8-b767-990e5d2f8561",

"inserted_at": "2024-05-27T11:09:27",

"updated_at": "2024-05-27T11:09:27",

"url": "https://my-saas.app"

}`

tag/RedirectUris/operation/create-redirect-uri Create a Redirect URI

Create Redirect URI for an environment by specifying the url to allow redirection after successful authentication.

RETURNS

Returns Redirect URI attached to the environment if creation succeeded. Returns an error if creation failed

query Parameters

Responses

201

Created

422

Unprocessable Entity

post/api/v2/redirect_uris

https://${{cryptr_service_url}}/api/v2/redirect_uris

Request samples

• cURL

Copy

curl -X POST '${cryptr_service_url}/api/v2/redirect_uris' \
  -d url='https://my-saas.app/api/v2/redirect_uris' \

Response samples

• 201
• 422

Content type

application/json

Copy

`{"environment": "sandbox",

"type": "RedirectUri",

"default": true,

"id": "20c8da6b-8086-45f8-b767-990e5d2f8561",

"inserted_at": "2024-05-27T11:09:27",

"updated_at": "2024-05-27T11:09:27",

"url": "https://my-saas.app"

}`

tag/RedirectUris/operation/delete-redirect-uri Delete a Redirect URI

Delete a Redirect URI for an environment.

RETURNS

Returns the deleted Redirect URI for an environment/

path Parameters

Responses

200

OK

404

Not Found

422

Unprocessable Entity

delete/api/v2/redirect_uris/{id}

https://${{cryptr_service_url}}/api/v2/redirect_uris/{id}

Request samples

• cURL

Copy

curl -X DELETE '${cryptr_service_url}/api/v2/:id'

Response samples

• 200
• 404
• 422

Content type

application/json

Copy Expand all Collapse all

`{"deleted": true,

"resource": {"environment": "sandbox",

"type": "RedirectUri",

"default": false,

"id": "20c8da6b-8086-45f8-b767-990e5d2f8561",

"inserted_at": "2024-05-27T11:09:27",

"updated_at": "2024-05-27T11:09:27",

"url": "https://my-saas.app"

}

}`

tag/RedirectUris/operation/list-redirect-uris List all Redirect URIs

Return a list of all Redirect URI for the environment according to the expected pagination.

RETURNS

A dictionary with data that contains an array of up to the limit of Redirect URI. Each entry in the array represents a separate Redirect URI type. If no matching Redirect URI is available, the resulting array will be empty. This request should never return an error.

query Parameters

Responses

200

OK

get/api/v2/redirect_uris

https://${{cryptr_service_url}}/api/v2/redirect_uris

Request samples

• cURL

Copy

curl -X '${cryptr_service_url}/api/v2/redirect_uris'

Response samples

• 200

Content type

application/json

Copy Expand all Collapse all

`{"data": [{"environment": "sandbox",

"type": "RedirectUri",

"default": false,

"id": "20c8da6b-8086-45f8-b767-990e5d2f8561",

"inserted_at": "2024-05-27T11:09:27",

"updated_at": "2024-05-27T11:09:27",

"url": "https://my-saas.app"\
}

],

"pagination": {"current_page": 4,

"current_pages": [1,

2,

3,

4,

5,

6,

"...",

16

],

"next_page": 5,

"per_page": 2,

"prev_page": 3,

"total_pages": 16

},

"total": 0

}`

tag/RedirectUris/operation/retrieve-redirect-uri Retrieve a Redirect URI

Retrieve a Redirect URI by specifying its given id.

RETURNS

Returns a Redirect URI for a valid identifier. If no match is found, a Not Found error will be returned.

path Parameters

Responses

200

OK

404

Not Found

get/api/v2/redirect_uris/{id}

https://${{cryptr_service_url}}/api/v2/redirect_uris/{id}

Request samples

• cURL

Copy

curl -X '${cryptr_service_url}/api/v2/:id'

Response samples

• 200
• 404

Content type

application/json

Copy

`{"environment": "sandbox",

"type": "RedirectUri",

"default": true,

"id": "20c8da6b-8086-45f8-b767-990e5d2f8561",

"inserted_at": "2024-05-27T11:09:27",

"updated_at": "2024-05-27T11:09:27",

"url": "https://my-saas.app"

}`

tag/RedirectUris/operation/set-redirect-uri-as-default Set Redirect URI as default

Set a Redirect URI for its environment.

When a Redirect URI is the default of the environment, it cannot be deleted until another one is set as default. For each authentication request that has no redirect URI provided, the default Redirect URI will be used according to the request’s environment.

RETURNS

Returns the Redirect URI with default set to true if the request succeeds.

path Parameters

Responses

200

OK

404

Not Found

put/api/v2/redirect_uris/{id}/set-as-default

https://${{cryptr_service_url}}/api/v2/redirect_uris/{id}/set-as-default

Request samples

• cURL

Copy

curl -X PUT '${cryptr_service_url}/api/v2/:id/set-as-default'

Response samples

• 200
• 404

Content type

application/json

Copy

`{"environment": "sandbox",

"type": "RedirectUri",

"default": true,

"id": "20c8da6b-8086-45f8-b767-990e5d2f8561",

"inserted_at": "2024-05-27T11:09:27",

"updated_at": "2024-05-27T11:09:27",

"url": "https://my-saas.app"

}`

tag/Token 🔐 Token

The Token type

The token is used to authorize access to a given service. This could be, for example, authorizing a user to access a service or authorizing a request to communicate with an API.

Copy Expand all Collapse all

`{"access_token": "eyJhbGciOiJSUzI1NiIsImlzcyI6Imh0...",

"expires_in": 36000,

"id_token": "eyJhbGciOiJSUzI1NiIsImlzcyI6Imh0...",

"scope": ["openid",

"email",

"profile"

],

"token_type": "Bearer"

}`

The MetaKey type

When an authentication is successful (after a successful Magic Link or SSO Connection process), JWT are generated to authenticate and identify User.

These tokens can be customized with Metadata. To do so you first need to declare a MetaKey to use it on your User resource. If you already have a declared MetaKey and you want to add MetaData to a User the corresponding documentation is in the User Tab.

Copy

`{"name": "uid",

"required": false,

"type": "string"

}`

tag/Token/operation/create-token Create a Token

Create a Token.

RETURNS

Returns the Access Token, ID Token...

query Parameters

Responses

201

Created

post/oauth/token

https://${{cryptr_service_url}}/oauth/token

Request samples

• cURL Client Credentials
• cURL Authorization Code
• cURL Relay

Copy

curl -X POST '${cryptr_service_url}/oauth/token' \
  -d grant_type='client_credentials' \
  -d client_id='2fd63d8d-8f1d-42f2-9b13-9e698b821e4f' \
  -d client_secret='my-secret'

Response samples

• 201

Content type

application/json

Copy Expand all Collapse all

`{"access_token": "eyJhbGciOiJSUzI1NiIsImlzcyI6Imh0...",

"expires_in": 36000,

"id_token": "eyJhbGciOiJSUzI1NiIsImlzcyI6Imh0...",

"scope": ["openid",

"email",

"profile"

],

"token_type": "Bearer"

}`

tag/Token/operation/create-user-metakey Create a User Metakey

Define a MetaKey with a specific name that applies to all users within each of your organizations. You can later use these special fields to store data you need in your application. You choose what you want to store and under what key. This way if the basic fields of Cryptr are not sufficient you can add your own fields.

The field will be available in the Tokens, if the User have an associated value in this Key, after a successful user authentication.

RETURNS

The allowed Metakey you just created. You can now specify the value of this key on any User, from any Organization.

query Parameters

Responses

200

Created MetaKey response

401

Unauthorized

post/api/v2/tokens/user-metakeys

https://${{cryptr_service_url}}/api/v2/tokens/user-metakeys

Request samples

• cURL

Copy

curl -X POST '${cryptr_service_url}/api/v2/tokens/user-metakeys' \
  -d key='uid'

Response samples

• 200
• 401

Content type

application/json

Copy

`{"name": "uid",

"required": false,

"type": "string"

}`

tag/Token/operation/list-user-metakey List all User Metakeys

List all stored user MetaKey.

RETURNS

The list of all user MetaKey available on your service

Responses

200

Fetched MetaKey(s) response

401

Unauthorized

get/api/v2/tokens/user-metakeys

https://${{cryptr_service_url}}/api/v2/tokens/user-metakeys

Request samples

• cURL

Copy

curl -X GET '${cryptr_service_url}/api/v2/tokens/user-metakeys'

Response samples

• 200
• 401

Content type

application/json

Copy Expand all Collapse all

[{"name": "uid",\ \ "required": false,\ \ "type": "string"\ \ }\ \ ]

tag/Token/operation/remove-user-metakey Remove a User MetaKey

Use the below request when a MetaKey is no more useful. While the Metakey is being deleted the Key will be locked and no operation can be used on this key.

RETURNS

The deleted Key Metadata with a confirmation it is deleted.

query Parameters

Responses

200

Deleted MetaKey response

401

Unauthorized

404

Not Found

delete/api/v2/tokens/user-metakeys

https://${{cryptr_service_url}}/api/v2/tokens/user-metakeys

Request samples

• cURL

Copy

curl -X GET '${cryptr_service_url}/api/v2/tokens/user-metakeys' \
  -d key='uid'

Response samples

• 200
• 401
• 404

Content type

application/json

Copy Expand all Collapse all

`{"deleted": true,

"resource": {"name": "uid",

"required": false,

"type": "string"

}

}`