From e434b8e0df8405b3be69b51558aba4e7d6c95580 Mon Sep 17 00:00:00 2001 From: Marcelo Salloum Date: Thu, 18 Jan 2024 13:56:35 -0800 Subject: [PATCH 1/6] Flip flag usage from ENABLE_RECAPTCHA to DISABLE_RECAPTCHA. --- .../resources/authenticate-mfa.api.mdx | 4 ++-- api/stellar-disbursement-platform/resources/log-in.api.mdx | 4 ++-- openapi/stellar-disbursement-platform/bundled.yml | 4 ++-- openapi/stellar-disbursement-platform/main.yml | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/api/stellar-disbursement-platform/resources/authenticate-mfa.api.mdx b/api/stellar-disbursement-platform/resources/authenticate-mfa.api.mdx index 5580bb2b8..fca68728f 100644 --- a/api/stellar-disbursement-platform/resources/authenticate-mfa.api.mdx +++ b/api/stellar-disbursement-platform/resources/authenticate-mfa.api.mdx @@ -5,7 +5,7 @@ description: "Governs the multi-factor authentication process for SDP user login sidebar_label: "Provide Multi-Factor Authentication" hide_title: true hide_table_of_contents: true -api: {"description":"Governs the multi-factor authentication process for SDP user login, including the ability to remember the device so MFA is not always required.","operationId":"authenticateMFA","tags":["Authentication"],"parameters":[{"in":"header","name":"Device-ID","required":false,"description":"Identifier of the device","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"mfa_code":{"type":"string","description":"Multi-factor authentication code"},"remember_me":{"type":"boolean","description":"Boolean flag to remember the user"},"recaptcha_token":{"type":"string","description":"Token for reCAPTCHA validation. ReCAPTCHA token is only required when `ENABLE_RECAPTCHA` configuration is set to true."}},"required":["mfa_code"]}}},"description":"MFA request data","required":true},"responses":{"200":{"description":"Successful authentication","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","description":"Authentication token"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}},"method":"post","path":"/mfa","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"mfa_code":"string","remember_me":true,"recaptcha_token":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Provide Multi-Factor Authentication","description":{"content":"Governs the multi-factor authentication process for SDP user login, including the ability to remember the device so MFA is not always required.","type":"text/plain"},"url":{"path":["mfa"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"Identifier of the device","type":"text/plain"},"key":"Device-ID","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"description":"Governs the multi-factor authentication process for SDP user login, including the ability to remember the device so MFA is not always required.","operationId":"authenticateMFA","tags":["Authentication"],"parameters":[{"in":"header","name":"Device-ID","required":false,"description":"Identifier of the device","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"mfa_code":{"type":"string","description":"Multi-factor authentication code"},"remember_me":{"type":"boolean","description":"Boolean flag to remember the user"},"recaptcha_token":{"type":"string","description":"Token for reCAPTCHA validation. ReCAPTCHA token is required unless the `DISABLE_RECAPTCHA` configuration is set to true."}},"required":["mfa_code"]}}},"description":"MFA request data","required":true},"responses":{"200":{"description":"Successful authentication","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string","description":"Authentication token"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Details about the error"}}}}}},"401":{"description":"Unauthorized","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}},"examples":{"response":{"value":{"error":"Not authorized","extras":{"status":401,"message":"Not authorized"}}}}}}}},"method":"post","path":"/mfa","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"mfa_code":"string","remember_me":true,"recaptcha_token":"string"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Provide Multi-Factor Authentication","description":{"content":"Governs the multi-factor authentication process for SDP user login, including the ability to remember the device so MFA is not always required.","type":"text/plain"},"url":{"path":["mfa"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"Identifier of the device","type":"text/plain"},"key":"Device-ID","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null @@ -34,7 +34,7 @@ Governs the multi-factor authentication process for SDP user login, including th MFA request data -
+
Successful authentication diff --git a/api/stellar-disbursement-platform/resources/log-in.api.mdx b/api/stellar-disbursement-platform/resources/log-in.api.mdx index b8f382f11..46e9ffa03 100644 --- a/api/stellar-disbursement-platform/resources/log-in.api.mdx +++ b/api/stellar-disbursement-platform/resources/log-in.api.mdx @@ -5,7 +5,7 @@ description: "Allows credentialed SDP users to log in to the SDP dashboard with sidebar_label: "Log In" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}},"example":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}},"examples":{"response":{"value":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}}}}}},"400":{"description":"Bad Request","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Invalid credentials","extras":{"status":400,"message":"Invalid username or password"}}},"examples":{"response":{"value":{"error":"Invalid credentials","extras":{"status":400,"message":"Invalid username or password"}}}}}}}},"operationId":"Log In","description":"Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols.","tags":["Authentication"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"password":{"type":"string"},"recaptcha_token":{"type":"string","description":"Token for reCAPTCHA validation. ReCAPTCHA token is only required when `ENABLE_RECAPTCHA` configuration is set to true."}},"required":["email","password"],"example":{"email":"johndoe@mail.com","password":"mysecret"}}}}},"method":"post","path":"/login","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"email":"johndoe@mail.com","password":"mysecret"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Log In","description":{"content":"Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols.","type":"text/plain"},"url":{"path":["login"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}},"example":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}},"examples":{"response":{"value":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}}}}}},"400":{"description":"Bad Request","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Invalid credentials","extras":{"status":400,"message":"Invalid username or password"}}},"examples":{"response":{"value":{"error":"Invalid credentials","extras":{"status":400,"message":"Invalid username or password"}}}}}}}},"operationId":"Log In","description":"Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols.","tags":["Authentication"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"password":{"type":"string"},"recaptcha_token":{"type":"string","description":"Token for reCAPTCHA validation. ReCAPTCHA token is unless the `DISABLE_RECAPTCHA` configuration is set to true."}},"required":["email","password"],"example":{"email":"johndoe@mail.com","password":"mysecret"}}}}},"method":"post","path":"/login","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"email":"johndoe@mail.com","password":"mysecret"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Log In","description":{"content":"Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols.","type":"text/plain"},"url":{"path":["login"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null @@ -30,7 +30,7 @@ import TabItem from "@theme/TabItem"; Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols. -
Request Body
+
Request Body
OK diff --git a/openapi/stellar-disbursement-platform/bundled.yml b/openapi/stellar-disbursement-platform/bundled.yml index aeb8eb82c..6a1f9ab33 100644 --- a/openapi/stellar-disbursement-platform/bundled.yml +++ b/openapi/stellar-disbursement-platform/bundled.yml @@ -63,7 +63,7 @@ paths: type: string recaptcha_token: type: string - description: Token for reCAPTCHA validation. ReCAPTCHA token is only required when `ENABLE_RECAPTCHA` configuration is set to true. + description: Token for reCAPTCHA validation. ReCAPTCHA token is required unless the `DISABLE_RECAPTCHA` configuration is set to true. required: - email - password @@ -125,7 +125,7 @@ paths: description: Boolean flag to remember the user recaptcha_token: type: string - description: Token for reCAPTCHA validation. ReCAPTCHA token is only required when `ENABLE_RECAPTCHA` configuration is set to true. + description: Token for reCAPTCHA validation. ReCAPTCHA token is required unless the `DISABLE_RECAPTCHA` configuration is set to true. required: - mfa_code - in: header diff --git a/openapi/stellar-disbursement-platform/main.yml b/openapi/stellar-disbursement-platform/main.yml index e8c044d05..cb12af9ae 100644 --- a/openapi/stellar-disbursement-platform/main.yml +++ b/openapi/stellar-disbursement-platform/main.yml @@ -65,7 +65,7 @@ paths: type: string recaptcha_token: type: string - description: "Token for reCAPTCHA validation. ReCAPTCHA token is only required when `ENABLE_RECAPTCHA` configuration is set to true." + description: "Token for reCAPTCHA validation. ReCAPTCHA token is required unless the `DISABLE_RECAPTCHA` configuration is set to true." required: - email - password @@ -129,7 +129,7 @@ paths: description: Boolean flag to remember the user recaptcha_token: type: string - description: "Token for reCAPTCHA validation. ReCAPTCHA token is only required when `ENABLE_RECAPTCHA` configuration is set to true." + description: "Token for reCAPTCHA validation. ReCAPTCHA token is required unless the `DISABLE_RECAPTCHA` configuration is set to true." required: - mfa_code - in: header From 347fe2c10d97789b1447468fdb17bb66aff9b654 Mon Sep 17 00:00:00 2001 From: Marcelo Salloum Date: Thu, 18 Jan 2024 13:58:54 -0800 Subject: [PATCH 2/6] Fix wording. --- api/stellar-disbursement-platform/resources/log-in.api.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api/stellar-disbursement-platform/resources/log-in.api.mdx b/api/stellar-disbursement-platform/resources/log-in.api.mdx index 46e9ffa03..68ad51480 100644 --- a/api/stellar-disbursement-platform/resources/log-in.api.mdx +++ b/api/stellar-disbursement-platform/resources/log-in.api.mdx @@ -5,7 +5,7 @@ description: "Allows credentialed SDP users to log in to the SDP dashboard with sidebar_label: "Log In" hide_title: true hide_table_of_contents: true -api: {"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}},"example":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}},"examples":{"response":{"value":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}}}}}},"400":{"description":"Bad Request","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Invalid credentials","extras":{"status":400,"message":"Invalid username or password"}}},"examples":{"response":{"value":{"error":"Invalid credentials","extras":{"status":400,"message":"Invalid username or password"}}}}}}}},"operationId":"Log In","description":"Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols.","tags":["Authentication"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"password":{"type":"string"},"recaptcha_token":{"type":"string","description":"Token for reCAPTCHA validation. ReCAPTCHA token is unless the `DISABLE_RECAPTCHA` configuration is set to true."}},"required":["email","password"],"example":{"email":"johndoe@mail.com","password":"mysecret"}}}}},"method":"post","path":"/login","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"email":"johndoe@mail.com","password":"mysecret"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Log In","description":{"content":"Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols.","type":"text/plain"},"url":{"path":["login"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}},"example":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}},"examples":{"response":{"value":{"token":"eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoidXNlci1pZCIsImVtYWlsIjoiZW1haWxAZW1haWwuY29tIiwicm9sZXMiOlt7Im5hbWUiOiJTdXBlcnZpc29yIn1dfSwiZXhwIjoxNjc1OTYyOTQ3fQ.4Zj9yBXch-iuFYF-kc_EhHPxjpwp_egMOLbOv4bZKO1MFvcmEgZ5MlXH1_1fZfgUxaNBcMCdRM6MGSqKocwGnA"}}}}}},"400":{"description":"Bad Request","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"extras":{"type":"object","properties":{"status":{"type":"number"},"message":{"type":"string"}}}},"example":{"error":"Invalid credentials","extras":{"status":400,"message":"Invalid username or password"}}},"examples":{"response":{"value":{"error":"Invalid credentials","extras":{"status":400,"message":"Invalid username or password"}}}}}}}},"operationId":"Log In","description":"Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols.","tags":["Authentication"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"password":{"type":"string"},"recaptcha_token":{"type":"string","description":"Token for reCAPTCHA validation. ReCAPTCHA token is required unless the `DISABLE_RECAPTCHA` configuration is set to true."}},"required":["email","password"],"example":{"email":"johndoe@mail.com","password":"mysecret"}}}}},"method":"post","path":"/login","securitySchemes":{"BearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"JWT used for authentication, signed with an ES256 private key."}},"jsonRequestBodyExample":{"email":"johndoe@mail.com","password":"mysecret"},"info":{"title":"Stellar Disbursement Platform API","version":"","description":"The Stellar Disbursement Platform (SDP) is a tool built for organizations to make bulk payments to a group of recipients over the Stellar network. You can read more about using the SDP [here](https://developers.stellar.org/docs/category/use-the-stellar-disbursement-platform)."},"postman":{"name":"Log In","description":{"content":"Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols.","type":"text/plain"},"url":{"path":["login"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "post api-method" info_path: api/stellar-disbursement-platform/resources/stellar-disbursement-platform-api custom_edit_url: null @@ -30,7 +30,7 @@ import TabItem from "@theme/TabItem"; Allows credentialed SDP users to log in to the SDP dashboard with a password. Note: all passwords must be at least 8 characters long and a combination of uppercase letters, lowercase letters, numbers, and symbols. -
Request Body
+
Request Body
OK From 1768260ec069a15f91de61c3804dd9da9176fa64 Mon Sep 17 00:00:00 2001 From: Marcelo Salloum Date: Thu, 18 Jan 2024 14:37:03 -0800 Subject: [PATCH 3/6] Add Secure Operation Manual section to the SDP. --- .../secure-operation-manual.mdx | 44 +++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 docs/stellar-disbursement-platform/secure-operation-manual.mdx diff --git a/docs/stellar-disbursement-platform/secure-operation-manual.mdx b/docs/stellar-disbursement-platform/secure-operation-manual.mdx new file mode 100644 index 000000000..7d9f3a8ec --- /dev/null +++ b/docs/stellar-disbursement-platform/secure-operation-manual.mdx @@ -0,0 +1,44 @@ +--- +title: Secure Operation Manual +sidebar_position: 41 +--- + +This manual outlines the security measures implemented in the Stellar Disbursement Platform (SDP) to protect the integrity of the platform and its users. By adhering to these guidelines, you can ensure that your use of the SDP is as secure as possible. + +Security is a critical aspect of the SDP. The measures outlined in this document are designed to mitigate risks and enhance the security of the platform. Users are strongly encouraged to follow these guidelines to protect their accounts and operations. + +### Implementation of reCAPTCHA + +Google's reCAPTCHA has been integrated into the SDP to prevent automated attacks and ensure that interactions are performed by humans, not bots. + +ReCAPTCHA is enabled by default and can be disabled in the development environment by setting the `DISABLE_RECAPTCHA` environment variable to `true`. + +**Note:** Disabling reCAPTCHA is not supported for production environments due to security risks. + +### Enforcement of Multi-Factor Authentication + +Multi-Factor Authentication (MFA) provides an additional layer of security to user accounts. It is enforced by default on the SDP and it relies on OTPs sent to the account's email. + +MFA is enabled by default and can be disabled in the development environment by setting the `DISABLE_MFA` environment variable to `true`. + +**Note:** Disabling MFA is not supported for production environments due to security risks. + +### Best Practices for Wallet Management + +The SDP wallet should be used primarily as a hot wallet with a limited amount of funds to minimize potential losses. + +#### Hot and Cold Wallets + +- A hot wallet is connected to the internet and allows for quick transactions. +- A cold wallet is offline and used for storing funds securely. +- Learn more about these concepts at [Investopedia](https://www.investopedia.com/hot-wallet-vs-cold-wallet-7098461). + +### Distribution of Disbursement Responsibilities + +To enhance security, disbursement responsibilities should be distributed among multiple financial controller users. + +#### Recommended Configuration + +1. **Approval Flow**: Enable the approval flow on the organization page to require two users for the disbursement process. The owner can do that at *Profile > Organization > ... > Edit details > Approval flow > Confirm*. +2. **Financial Controller Role**: Create two users with the *Financial Controller* role on the organization page to enforce separation of duties. The owner can do hat at *Settings > Team Members*. +3. **Owner Account Management**: Use the Owner account solely for user management and organization configuration. Avoid using the Owner account for financial controller tasks to minimize the exposure of that account. \ No newline at end of file From 98aaa78f44d615d2f649dec32f4a3c78a82f4b2e Mon Sep 17 00:00:00 2001 From: Marcelo Salloum Date: Thu, 18 Jan 2024 14:41:17 -0800 Subject: [PATCH 4/6] Run prettier. --- .../secure-operation-manual.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/stellar-disbursement-platform/secure-operation-manual.mdx b/docs/stellar-disbursement-platform/secure-operation-manual.mdx index 7d9f3a8ec..eeaf4d4e9 100644 --- a/docs/stellar-disbursement-platform/secure-operation-manual.mdx +++ b/docs/stellar-disbursement-platform/secure-operation-manual.mdx @@ -39,6 +39,6 @@ To enhance security, disbursement responsibilities should be distributed among m #### Recommended Configuration -1. **Approval Flow**: Enable the approval flow on the organization page to require two users for the disbursement process. The owner can do that at *Profile > Organization > ... > Edit details > Approval flow > Confirm*. -2. **Financial Controller Role**: Create two users with the *Financial Controller* role on the organization page to enforce separation of duties. The owner can do hat at *Settings > Team Members*. -3. **Owner Account Management**: Use the Owner account solely for user management and organization configuration. Avoid using the Owner account for financial controller tasks to minimize the exposure of that account. \ No newline at end of file +1. **Approval Flow**: Enable the approval flow on the organization page to require two users for the disbursement process. The owner can do that at _Profile > Organization > ... > Edit details > Approval flow > Confirm_. +2. **Financial Controller Role**: Create two users with the _Financial Controller_ role on the organization page to enforce separation of duties. The owner can do hat at _Settings > Team Members_. +3. **Owner Account Management**: Use the Owner account solely for user management and organization configuration. Avoid using the Owner account for financial controller tasks to minimize the exposure of that account. From ef4f289131ed18ff17a4cd476f278e259b145bdb Mon Sep 17 00:00:00 2001 From: Marcelo Salloum Date: Thu, 18 Jan 2024 14:50:49 -0800 Subject: [PATCH 5/6] Rename files so the project files are in the same order as rendered in the interface. --- .../{overview.mdx => 10-overview.mdx} | 0 ...sign-and-architecture.mdx => 20-design-and-architecture.mdx} | 0 .../{getting-started.mdx => 30-getting-started.mdx} | 0 .../10-dashboard-home.mdx} | 0 .../20-disbursements.mdx} | 0 .../receivers.mdx => 40-user-interface/30-receivers.mdx} | 0 .../payments.mdx => 40-user-interface/40-payments.mdx} | 0 .../wallets.mdx => 40-user-interface/50-wallets.mdx} | 0 .../analytics.mdx => 40-user-interface/60-analytics.mdx} | 0 .../{user-interface => 40-user-interface}/_category_.json | 0 .../{deploy-the-sdp.mdx => 41-deploy-the-sdp.mdx} | 2 +- ...cure-operation-manual.mdx => 42-secure-operation-manual.mdx} | 2 +- ...wallet-sdp-ready.mdx => 50-making-your-wallet-sdp-ready.mdx} | 0 ...ion-points.mdx => 60-anchor-platform-integration-points.mdx} | 0 14 files changed, 2 insertions(+), 2 deletions(-) rename docs/stellar-disbursement-platform/{overview.mdx => 10-overview.mdx} (100%) rename docs/stellar-disbursement-platform/{design-and-architecture.mdx => 20-design-and-architecture.mdx} (100%) rename docs/stellar-disbursement-platform/{getting-started.mdx => 30-getting-started.mdx} (100%) rename docs/stellar-disbursement-platform/{user-interface/dashboard-home.mdx => 40-user-interface/10-dashboard-home.mdx} (100%) rename docs/stellar-disbursement-platform/{user-interface/disbursements.mdx => 40-user-interface/20-disbursements.mdx} (100%) rename docs/stellar-disbursement-platform/{user-interface/receivers.mdx => 40-user-interface/30-receivers.mdx} (100%) rename docs/stellar-disbursement-platform/{user-interface/payments.mdx => 40-user-interface/40-payments.mdx} (100%) rename docs/stellar-disbursement-platform/{user-interface/wallets.mdx => 40-user-interface/50-wallets.mdx} (100%) rename docs/stellar-disbursement-platform/{user-interface/analytics.mdx => 40-user-interface/60-analytics.mdx} (100%) rename docs/stellar-disbursement-platform/{user-interface => 40-user-interface}/_category_.json (100%) rename docs/stellar-disbursement-platform/{deploy-the-sdp.mdx => 41-deploy-the-sdp.mdx} (99%) rename docs/stellar-disbursement-platform/{secure-operation-manual.mdx => 42-secure-operation-manual.mdx} (99%) rename docs/stellar-disbursement-platform/{making-your-wallet-sdp-ready.mdx => 50-making-your-wallet-sdp-ready.mdx} (100%) rename docs/stellar-disbursement-platform/{anchor-platform-integration-points.mdx => 60-anchor-platform-integration-points.mdx} (100%) diff --git a/docs/stellar-disbursement-platform/overview.mdx b/docs/stellar-disbursement-platform/10-overview.mdx similarity index 100% rename from docs/stellar-disbursement-platform/overview.mdx rename to docs/stellar-disbursement-platform/10-overview.mdx diff --git a/docs/stellar-disbursement-platform/design-and-architecture.mdx b/docs/stellar-disbursement-platform/20-design-and-architecture.mdx similarity index 100% rename from docs/stellar-disbursement-platform/design-and-architecture.mdx rename to docs/stellar-disbursement-platform/20-design-and-architecture.mdx diff --git a/docs/stellar-disbursement-platform/getting-started.mdx b/docs/stellar-disbursement-platform/30-getting-started.mdx similarity index 100% rename from docs/stellar-disbursement-platform/getting-started.mdx rename to docs/stellar-disbursement-platform/30-getting-started.mdx diff --git a/docs/stellar-disbursement-platform/user-interface/dashboard-home.mdx b/docs/stellar-disbursement-platform/40-user-interface/10-dashboard-home.mdx similarity index 100% rename from docs/stellar-disbursement-platform/user-interface/dashboard-home.mdx rename to docs/stellar-disbursement-platform/40-user-interface/10-dashboard-home.mdx diff --git a/docs/stellar-disbursement-platform/user-interface/disbursements.mdx b/docs/stellar-disbursement-platform/40-user-interface/20-disbursements.mdx similarity index 100% rename from docs/stellar-disbursement-platform/user-interface/disbursements.mdx rename to docs/stellar-disbursement-platform/40-user-interface/20-disbursements.mdx diff --git a/docs/stellar-disbursement-platform/user-interface/receivers.mdx b/docs/stellar-disbursement-platform/40-user-interface/30-receivers.mdx similarity index 100% rename from docs/stellar-disbursement-platform/user-interface/receivers.mdx rename to docs/stellar-disbursement-platform/40-user-interface/30-receivers.mdx diff --git a/docs/stellar-disbursement-platform/user-interface/payments.mdx b/docs/stellar-disbursement-platform/40-user-interface/40-payments.mdx similarity index 100% rename from docs/stellar-disbursement-platform/user-interface/payments.mdx rename to docs/stellar-disbursement-platform/40-user-interface/40-payments.mdx diff --git a/docs/stellar-disbursement-platform/user-interface/wallets.mdx b/docs/stellar-disbursement-platform/40-user-interface/50-wallets.mdx similarity index 100% rename from docs/stellar-disbursement-platform/user-interface/wallets.mdx rename to docs/stellar-disbursement-platform/40-user-interface/50-wallets.mdx diff --git a/docs/stellar-disbursement-platform/user-interface/analytics.mdx b/docs/stellar-disbursement-platform/40-user-interface/60-analytics.mdx similarity index 100% rename from docs/stellar-disbursement-platform/user-interface/analytics.mdx rename to docs/stellar-disbursement-platform/40-user-interface/60-analytics.mdx diff --git a/docs/stellar-disbursement-platform/user-interface/_category_.json b/docs/stellar-disbursement-platform/40-user-interface/_category_.json similarity index 100% rename from docs/stellar-disbursement-platform/user-interface/_category_.json rename to docs/stellar-disbursement-platform/40-user-interface/_category_.json diff --git a/docs/stellar-disbursement-platform/deploy-the-sdp.mdx b/docs/stellar-disbursement-platform/41-deploy-the-sdp.mdx similarity index 99% rename from docs/stellar-disbursement-platform/deploy-the-sdp.mdx rename to docs/stellar-disbursement-platform/41-deploy-the-sdp.mdx index f6e8e9917..61ed8d3ce 100644 --- a/docs/stellar-disbursement-platform/deploy-the-sdp.mdx +++ b/docs/stellar-disbursement-platform/41-deploy-the-sdp.mdx @@ -1,6 +1,6 @@ --- title: Deploy the SDP -sidebar_position: 40 +sidebar_position: 41 --- In this guide, you will learn to deploy the SDP on a Kubernetes cluster using publicly available Helm charts. diff --git a/docs/stellar-disbursement-platform/secure-operation-manual.mdx b/docs/stellar-disbursement-platform/42-secure-operation-manual.mdx similarity index 99% rename from docs/stellar-disbursement-platform/secure-operation-manual.mdx rename to docs/stellar-disbursement-platform/42-secure-operation-manual.mdx index eeaf4d4e9..ac7029ce6 100644 --- a/docs/stellar-disbursement-platform/secure-operation-manual.mdx +++ b/docs/stellar-disbursement-platform/42-secure-operation-manual.mdx @@ -1,6 +1,6 @@ --- title: Secure Operation Manual -sidebar_position: 41 +sidebar_position: 42 --- This manual outlines the security measures implemented in the Stellar Disbursement Platform (SDP) to protect the integrity of the platform and its users. By adhering to these guidelines, you can ensure that your use of the SDP is as secure as possible. diff --git a/docs/stellar-disbursement-platform/making-your-wallet-sdp-ready.mdx b/docs/stellar-disbursement-platform/50-making-your-wallet-sdp-ready.mdx similarity index 100% rename from docs/stellar-disbursement-platform/making-your-wallet-sdp-ready.mdx rename to docs/stellar-disbursement-platform/50-making-your-wallet-sdp-ready.mdx diff --git a/docs/stellar-disbursement-platform/anchor-platform-integration-points.mdx b/docs/stellar-disbursement-platform/60-anchor-platform-integration-points.mdx similarity index 100% rename from docs/stellar-disbursement-platform/anchor-platform-integration-points.mdx rename to docs/stellar-disbursement-platform/60-anchor-platform-integration-points.mdx From 7ff459adcaa9f4e994d51790e652e87e4d93be65 Mon Sep 17 00:00:00 2001 From: Marcelo Salloum Date: Thu, 18 Jan 2024 15:10:09 -0800 Subject: [PATCH 6/6] Revert "Rename files so the project files are in the same order as rendered in the interface." This reverts commit ef4f289131ed18ff17a4cd476f278e259b145bdb. --- ...ration-points.mdx => anchor-platform-integration-points.mdx} | 0 .../{41-deploy-the-sdp.mdx => deploy-the-sdp.mdx} | 2 +- ...-design-and-architecture.mdx => design-and-architecture.mdx} | 0 .../{30-getting-started.mdx => getting-started.mdx} | 0 ...ur-wallet-sdp-ready.mdx => making-your-wallet-sdp-ready.mdx} | 0 .../{10-overview.mdx => overview.mdx} | 0 ...-secure-operation-manual.mdx => secure-operation-manual.mdx} | 2 +- .../{40-user-interface => user-interface}/_category_.json | 0 .../60-analytics.mdx => user-interface/analytics.mdx} | 0 .../10-dashboard-home.mdx => user-interface/dashboard-home.mdx} | 0 .../20-disbursements.mdx => user-interface/disbursements.mdx} | 0 .../40-payments.mdx => user-interface/payments.mdx} | 0 .../30-receivers.mdx => user-interface/receivers.mdx} | 0 .../50-wallets.mdx => user-interface/wallets.mdx} | 0 14 files changed, 2 insertions(+), 2 deletions(-) rename docs/stellar-disbursement-platform/{60-anchor-platform-integration-points.mdx => anchor-platform-integration-points.mdx} (100%) rename docs/stellar-disbursement-platform/{41-deploy-the-sdp.mdx => deploy-the-sdp.mdx} (99%) rename docs/stellar-disbursement-platform/{20-design-and-architecture.mdx => design-and-architecture.mdx} (100%) rename docs/stellar-disbursement-platform/{30-getting-started.mdx => getting-started.mdx} (100%) rename docs/stellar-disbursement-platform/{50-making-your-wallet-sdp-ready.mdx => making-your-wallet-sdp-ready.mdx} (100%) rename docs/stellar-disbursement-platform/{10-overview.mdx => overview.mdx} (100%) rename docs/stellar-disbursement-platform/{42-secure-operation-manual.mdx => secure-operation-manual.mdx} (99%) rename docs/stellar-disbursement-platform/{40-user-interface => user-interface}/_category_.json (100%) rename docs/stellar-disbursement-platform/{40-user-interface/60-analytics.mdx => user-interface/analytics.mdx} (100%) rename docs/stellar-disbursement-platform/{40-user-interface/10-dashboard-home.mdx => user-interface/dashboard-home.mdx} (100%) rename docs/stellar-disbursement-platform/{40-user-interface/20-disbursements.mdx => user-interface/disbursements.mdx} (100%) rename docs/stellar-disbursement-platform/{40-user-interface/40-payments.mdx => user-interface/payments.mdx} (100%) rename docs/stellar-disbursement-platform/{40-user-interface/30-receivers.mdx => user-interface/receivers.mdx} (100%) rename docs/stellar-disbursement-platform/{40-user-interface/50-wallets.mdx => user-interface/wallets.mdx} (100%) diff --git a/docs/stellar-disbursement-platform/60-anchor-platform-integration-points.mdx b/docs/stellar-disbursement-platform/anchor-platform-integration-points.mdx similarity index 100% rename from docs/stellar-disbursement-platform/60-anchor-platform-integration-points.mdx rename to docs/stellar-disbursement-platform/anchor-platform-integration-points.mdx diff --git a/docs/stellar-disbursement-platform/41-deploy-the-sdp.mdx b/docs/stellar-disbursement-platform/deploy-the-sdp.mdx similarity index 99% rename from docs/stellar-disbursement-platform/41-deploy-the-sdp.mdx rename to docs/stellar-disbursement-platform/deploy-the-sdp.mdx index 61ed8d3ce..f6e8e9917 100644 --- a/docs/stellar-disbursement-platform/41-deploy-the-sdp.mdx +++ b/docs/stellar-disbursement-platform/deploy-the-sdp.mdx @@ -1,6 +1,6 @@ --- title: Deploy the SDP -sidebar_position: 41 +sidebar_position: 40 --- In this guide, you will learn to deploy the SDP on a Kubernetes cluster using publicly available Helm charts. diff --git a/docs/stellar-disbursement-platform/20-design-and-architecture.mdx b/docs/stellar-disbursement-platform/design-and-architecture.mdx similarity index 100% rename from docs/stellar-disbursement-platform/20-design-and-architecture.mdx rename to docs/stellar-disbursement-platform/design-and-architecture.mdx diff --git a/docs/stellar-disbursement-platform/30-getting-started.mdx b/docs/stellar-disbursement-platform/getting-started.mdx similarity index 100% rename from docs/stellar-disbursement-platform/30-getting-started.mdx rename to docs/stellar-disbursement-platform/getting-started.mdx diff --git a/docs/stellar-disbursement-platform/50-making-your-wallet-sdp-ready.mdx b/docs/stellar-disbursement-platform/making-your-wallet-sdp-ready.mdx similarity index 100% rename from docs/stellar-disbursement-platform/50-making-your-wallet-sdp-ready.mdx rename to docs/stellar-disbursement-platform/making-your-wallet-sdp-ready.mdx diff --git a/docs/stellar-disbursement-platform/10-overview.mdx b/docs/stellar-disbursement-platform/overview.mdx similarity index 100% rename from docs/stellar-disbursement-platform/10-overview.mdx rename to docs/stellar-disbursement-platform/overview.mdx diff --git a/docs/stellar-disbursement-platform/42-secure-operation-manual.mdx b/docs/stellar-disbursement-platform/secure-operation-manual.mdx similarity index 99% rename from docs/stellar-disbursement-platform/42-secure-operation-manual.mdx rename to docs/stellar-disbursement-platform/secure-operation-manual.mdx index ac7029ce6..eeaf4d4e9 100644 --- a/docs/stellar-disbursement-platform/42-secure-operation-manual.mdx +++ b/docs/stellar-disbursement-platform/secure-operation-manual.mdx @@ -1,6 +1,6 @@ --- title: Secure Operation Manual -sidebar_position: 42 +sidebar_position: 41 --- This manual outlines the security measures implemented in the Stellar Disbursement Platform (SDP) to protect the integrity of the platform and its users. By adhering to these guidelines, you can ensure that your use of the SDP is as secure as possible. diff --git a/docs/stellar-disbursement-platform/40-user-interface/_category_.json b/docs/stellar-disbursement-platform/user-interface/_category_.json similarity index 100% rename from docs/stellar-disbursement-platform/40-user-interface/_category_.json rename to docs/stellar-disbursement-platform/user-interface/_category_.json diff --git a/docs/stellar-disbursement-platform/40-user-interface/60-analytics.mdx b/docs/stellar-disbursement-platform/user-interface/analytics.mdx similarity index 100% rename from docs/stellar-disbursement-platform/40-user-interface/60-analytics.mdx rename to docs/stellar-disbursement-platform/user-interface/analytics.mdx diff --git a/docs/stellar-disbursement-platform/40-user-interface/10-dashboard-home.mdx b/docs/stellar-disbursement-platform/user-interface/dashboard-home.mdx similarity index 100% rename from docs/stellar-disbursement-platform/40-user-interface/10-dashboard-home.mdx rename to docs/stellar-disbursement-platform/user-interface/dashboard-home.mdx diff --git a/docs/stellar-disbursement-platform/40-user-interface/20-disbursements.mdx b/docs/stellar-disbursement-platform/user-interface/disbursements.mdx similarity index 100% rename from docs/stellar-disbursement-platform/40-user-interface/20-disbursements.mdx rename to docs/stellar-disbursement-platform/user-interface/disbursements.mdx diff --git a/docs/stellar-disbursement-platform/40-user-interface/40-payments.mdx b/docs/stellar-disbursement-platform/user-interface/payments.mdx similarity index 100% rename from docs/stellar-disbursement-platform/40-user-interface/40-payments.mdx rename to docs/stellar-disbursement-platform/user-interface/payments.mdx diff --git a/docs/stellar-disbursement-platform/40-user-interface/30-receivers.mdx b/docs/stellar-disbursement-platform/user-interface/receivers.mdx similarity index 100% rename from docs/stellar-disbursement-platform/40-user-interface/30-receivers.mdx rename to docs/stellar-disbursement-platform/user-interface/receivers.mdx diff --git a/docs/stellar-disbursement-platform/40-user-interface/50-wallets.mdx b/docs/stellar-disbursement-platform/user-interface/wallets.mdx similarity index 100% rename from docs/stellar-disbursement-platform/40-user-interface/50-wallets.mdx rename to docs/stellar-disbursement-platform/user-interface/wallets.mdx