You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Use this method to retrieve the details of a global Customer by using the password token during their [password reset process](/../api/customers-overview#customer-password-reset).
51
53
responses:
52
54
200:
53
55
body:
@@ -62,6 +64,8 @@ post:
62
64
get:
63
65
displayName: Get customer by email verification token
Use this method to retrieve a global Customer's details by using the email token during their [email verification process](/../api/customers-overview#customer-email-verification).
65
69
responses:
66
70
200:
67
71
body:
@@ -71,8 +75,11 @@ post:
71
75
type: base
72
76
post:
73
77
displayName: Create a Token for verifying the Customer's Email
74
-
description: Produces the [CustomerEmailTokenCreated](ctp:api:type:CustomerEmailTokenCreatedMessage) Message.
Use this method to create an email token for a global Customer during their [email verification process](/../api/customers-overview#customer-email-verification).
81
+
82
+
Creating an email token for the Customer produces the [CustomerEmailTokenCreated](ctp:api:type:CustomerEmailTokenCreatedMessage) Message.
Use this method to reset a global Customer's password during their [password reset process](/../api/customers-overview#customer-password-reset).
137
+
138
+
After the password is reset, any previously issued access and/or refresh tokens created through the [password flow](/authorization#password-flow) or [refresh token flow](/authorization#refresh-token-flow) are invalidated.
139
+
127
140
Resetting the password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=true`.
Use this method to create a password reset token for a global Customer during their [password reset process](/../api/customers-overview#customer-password-reset).
161
+
162
+
Creating a password reset token does not invalidate existing tokens.
Copy file name to clipboardExpand all lines: api-specs/api/resources/in-store.raml
+18-2Lines changed: 18 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1817,6 +1817,8 @@ uriParameters:
1817
1817
get:
1818
1818
displayName: Get customer by password verification token in store
1819
1819
description: |
1820
+
Use this method to retrieve a Store-specific Customer's details by using the password reset token during their [password reset process](/../api/customers-overview#customer-password-reset).
1821
+
1820
1822
If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
1821
1823
securedBy:
1822
1824
- oauth_2_0:
@@ -1837,6 +1839,8 @@ uriParameters:
1837
1839
get:
1838
1840
displayName: Get customer by email verification token in store
1839
1841
description: |
1842
+
Use this method to retrieve a Store-specific Customer's details by using the email token during their [email verification process](/../api/customers-overview#customer-email-verification).
1843
+
1840
1844
If the Customer exists in the Project but the `stores` field references a different [Store](ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
1841
1845
securedBy:
1842
1846
- oauth_2_0:
@@ -1854,6 +1858,8 @@ uriParameters:
1854
1858
post:
1855
1859
displayName: Create a Token for verifying the Customer's Email in store
1856
1860
description: |
1861
+
Use this method to create an email token for a Store-specific Customer during their [email verification process](/../api/customers-overview#customer-email-verification).
1862
+
1857
1863
If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
1858
1864
securedBy:
1859
1865
- oauth_2_0:
@@ -1874,7 +1880,8 @@ uriParameters:
1874
1880
post:
1875
1881
displayName: Verify Customer's Email in store
1876
1882
description: |
1877
-
The customer verifies the email using the token value.
1883
+
Use this method to verify a Store-specific Customer's email during their [email verification process](/../api/customers-overview#customer-email-verification).
1884
+
1878
1885
Verifying the email of the Customer produces the [CustomerEmailVerified](ctp:api:type:CustomerEmailVerifiedMessage) Message.
1879
1886
1880
1887
If the Customer exists in the Project but the `stores` field references a different [Store](ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
@@ -1920,9 +1927,14 @@ uriParameters:
1920
1927
post:
1921
1928
displayName: Reset Customer's Password in store
1922
1929
description: |
1930
+
Use this method to reset a Store-specific Customer's password during their [password reset process](/../api/customers-overview#customer-password-reset).
1931
+
1932
+
After the password is reset, any previously issued access and/or refresh tokens created through the [password flow](/authorization#password-flow) or [refresh token flow](/authorization#refresh-token-flow) are invalidated.
1933
+
1923
1934
Resetting the password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=true`.
1924
1935
1925
-
If the Customer exists in the Project but the `stores` field references a different [Store](ctp:api:type:Store), this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
1936
+
If the Customer exists in the Project but the `stores` field references a different [Store](ctp:api:type:Store), then this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
1937
+
1926
1938
securedBy:
1927
1939
- oauth_2_0:
1928
1940
scopes:
@@ -1944,6 +1956,10 @@ uriParameters:
1944
1956
post:
1945
1957
displayName: Create a Token for Resetting the Customer's Password in store
1946
1958
description: |
1959
+
Use this method to create a password reset token for a Store-specific Customer during their [password reset process](/../api/customers-overview#customer-password-reset).
1960
+
1961
+
Creating a password reset token does not invalidate existing tokens.
1962
+
1947
1963
If the Customer exists in the Project but the `stores` field references a different Store, this method returns a [ResourceNotFound](ctp:api:type:ResourceNotFoundError) error.
0 commit comments