2/2/2024 0 Comments Insomnia api documentation![]() The Pet Store specification will populate in the center panel of the Design tab. Click on start from an example (above the Import button), which will populate the sample Pet Store API. We’re going to import a sample file that’s built into Insomnia. The Design tab is the first of three top-level tabs in Documents. Test: Create test suites and individual tests for requests.Debug: Create, edit, and send individual requests.Design: Import and edit specifications, see API overview content, and preview a rendering of the API.We’ll walk through each tab in order from left to right, starting with the Design tab.ĭocuments have functionality separated into three tabs: Design, Debug, and Test. We’ve named our Document “petstore” as our example uses the Pet Store API. If you’re looking for information about Collections instead (which use Version Control Sync), see Request Collections.įor this guide, create an empty Document from your Dashboard. They also offer the capability to sync with Git. These user identifier options are available in the Insomnia Plugin I’ve developed to automate the generation of SAML assertions for testing of SAP SuccessFactors’ API’s – the name of the corresponding parameter is User Identifier Format .Design Documents (also called Documents) hold specifications, API requests, and tests. I hope this information can be useful for the developers/system administrators that are going to create or enhance SAML assertions for OAuth 2.0 authentication informing the Username and E-mail information from the SAP SuccessFactors’ user. Any value is accepted except empty value. The element is used to tag the SAML assertion. The NotBefore and NotOnOrAfter attributes in the element defines the validity period of the SAML assertion. If the Username is used as user identifier, then an additional AttributeStatement tag is required setting the use_username Attribute as true. The AttributeStatement element must contain the API key (clientId) that you obtained after you register the client application in Registering Your OAuth2 Client Application. The Recipient attribute must be set as the URL of the API server from which you request the OAuth token. User ID and Username: urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified.E-mail: urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress.The Format attribute has to be adjusted according to the user identifier type: It is important to highlight that this might be subject to SAP changes and it is not SAP official:Įnter the SAP SuccessFactors user identifier that you use to access the APIs in the NameID element. The screenshot below of the Manage Login Accounts tool from SAP SuccessFactors can help you to find the Username and E-Mail information for a specific user:īelow is an extended version of the SAP Documentation on how to generate SAML Assertions according to the informed user identifer. 2493579 – Employee Central: Person/User IDs Used Within Employee Central – SuccessFactors Employee Profile (sap.com).Differentiating Between Person ID, User ID, and User Name in Employee Central | SAP Help Portal.2495643 – SuccessFactors User IDs – Clarifying the Different IDs (sap.com).If you are unsure which of the three user identifiers (User ID, Username or E-Mail) you are going to use for SAP SuccessFactors authentication, the documents below can help you understand the difference between User ID and Username: An analysis of the SAML Username / E-Mail assertions generated by the SAP SuccessFactors /oauth/idp endpoint has allowed us to identify which attributes were added for each case and enhance the manually generated SAML Assertion according to the informed user identifier. ![]() This might be useful depending on the information that you have available at the moment the SAML Assertion is created yet the new documentation does not mention how to do that when creating the SAML assertion from scratch. However, if you have already used the soon-to-be deprecated /oauth/idp endpoint, you might have stumbled across the parameters use_email and use_username mentioned in the KBA 2668018 – Error message: “Unable to authenticate the client (Login failed – invalid user)” for Oauth Authentication, which allows SAML Assertions to be created using the Username and the E-mail as user identifiers. ![]() However, during the authentication tests of this method it was possible to see (with the help of my dear colleagues Helder Rodrigues and Sarah Homer from CoE EMEA ❤️) that the user identifier entered in the NameID tag of the resulting SAML assertion is always mapped to an User ID in SAP SuccessFactors. In the blog Testing SAP SuccessFactors’ API’s: How to use Insomnia to automate the generation of SAML Assertions I’ve followed the instructions provided on SAP documentation Generating a SAML Assertion to generate SAML assertions that could be used in the OAuth 2.0 authentication of SAP SuccessFactors’ API’s.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |