Welcome to MemberSuite REST & GraphQL API, at membersuite we appreciate the collaboration of third party developers and integrators in our quest to enhance our already comprehensive suite of collaboration products.
\nThe Membersuite Engineering Team brings you a comprehensive look at your options of integration with Membersuite. These include GraphQL, REST API options, Single Sign On, and Reverse Single Sign on.
\nDetails on Authentications using OAuth 2.0 are listed in the Auth Token section. A valid JWT Auth Token is the prerequisite to obtain any data via REST or GraphQL
\nThe most commonly used GraphQL queries are listed in this documentation for your reference. The beauty of GraphQL is being able to pull exactly the data you want no more, no less, and if you change your mind down the road the data should be easily retrievable.
\nIn cases, where there is more data to be had or full objects that are needed we also have the option to query using MSQL to our REST service. You will also have the option to call basic CRUD calls for much of the important information that you need.
\nSingle Sign On integrators will want to peruse this area of the documentation for specific instructions and calls related to SSO along with the aforementioned OAuth 2 jwt token generation.
\nSupport for OAuth 2 token SSO is here ! New and Improved ! No need to use SOAP token generation any longer. \nThe JWT SSO call will be listed in this area. A cURL will be provided for testing. Once you are done you be able to generate a url that will allow you to login seamlessly into the portal. Note: turn off automatic redirects and look in the location response header for the url. Also, keep in mind that the status code of succes is 302.
\nUserpool, TenantId, and ClientId will have to be requested of an administrator in order to generate a valid token for your user if you want to integrate a third party CMS. \nThe username, password, user pool, and client id of a current user will generate the token needed to pass to the JWTSSO/TenantId endpoint to generate your login url programmatically.
\nReverse SSO (Start on MS, Go To Third Party Site)\nAs part of your SSO solution you may want to redirect users in a RESET REQUIRED status to the reset password page. For that you need to refer to the Reset Password SSO sample call. YOU WILL REQUIRE THE ASSOCIATION ID of your Association from MemberSuite.\nThis call allows you to pass:
\nTo obtain the appropriate url, make a REST call to the isResetPassword SSO endpoint which is a bit lower down.\nThe url that is generated from posting nextUrl, isResetPassword, AssociationId, etc. will be in the following format:
\nNote: the nextUrl passed will be base 64 encoded and translated by membersuite to redirect the user.
\nAs part of your SSO solution you may want to redirect users to the create an account page. For that you need to refer to the isSignUp SSO sample call. YOU WILL REQUIRE THE ASSOCIATION ID of your Association from MemberSuite.\nThis call allows you to pass:
\nTo obtain the appropriate url, make a REST call to the isSignUp SSO endpoint which isa bit lower down the page.\nThe url that is generated from posting nextUrl, isResetPassword, AssociationId, etc. will be in the following format:
\nNote: the nextUrl passed will be base 64 encoded and translated by membersuite to redirect the user.
\nSteps:
\nSample flow listed in Profile Retrieval Folder
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"GraphQL","slug":"graphql"},{"content":"REST API Services","slug":"rest-api-services"},{"content":"Single Sign On","slug":"single-sign-on"},{"content":"JWT SSO - NEW !","slug":"jwt-sso-new"},{"content":"Reverse SSO","slug":"reverse-sso"},{"content":"Refer to RegularSSO Post for generation of Token Guids","slug":"refer-to-regularsso-post-for-generation-of-token-guids"},{"content":"Another Method","slug":"another-method"},{"content":"Reset Password SSO","slug":"reset-password-sso"},{"content":"Login SSO","slug":"login-sso"},{"content":"Profile Retrieval","slug":"profile-retrieval"}],"owner":"30575908","collectionId":"579bd1b7-0a3f-4836-9820-86effe94fe0b","publishedId":"2s9YR9YYSP","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-10-19T01:48:48.000Z"},"item":[{"name":"Auth Tokens: 101","item":[{"name":"Who Am I","id":"1d426411-61d1-46ea-9b92-add9a120248a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"(Required) access token
\n"}],"url":"https://rest.membersuite.com/platform/v2/whoami","urlObject":{"protocol":"https","path":["platform","v2","whoami"],"host":["rest","membersuite","com"],"query":[],"variable":[]}},"response":[{"id":"35c57f79-c0d8-4881-a0b7-2ff9b5cc21ca","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"(Required) access token
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"(Required) access token
\n"},{"key":"Asynchronous","value":"Asynchronous operation
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"userId","value":"(Required)
\n","type":"text/plain"},"key":"tenantId","value":"(Required) access token
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"userId","value":"(Required) access token
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"newPassword","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"(Required) access token
\n"},{"key":"Asynchronous","value":"Asynchronous operation
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"(Required)
\n","type":"text/plain"},"type":"any","value":"There are two types of tokens available for MemberSuite. \n One of them is the Anonymous Token which can be used by any non-signed in user. \n The other is the Authenticated Token which can be used for an hour to access information under a specific user's information.
\nThe ability to obtain a refresh token and renew your session is also an option via some of the calls that land under the Authorization API at MemberSuite.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"da53400a-4aae-4291-b96b-52a29ba4275a"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"63b01676-62b8-46f3-88bb-3729768c14b3"}}],"_postman_id":"f3907f1a-644a-4a4a-a303-c84bb7b0b3e3"},{"name":"GraphQL","item":[{"name":"Event Browse Query","id":"c4411e0c-f289-4a86-b345-820060838bdf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This GraphQL library will offer you a comprehensive list of current, commonly used GraphQL queries that all third party developers can use to access information they need to accomplish their goals.
\nGraphQL is a query language for your API, and a server-side runtime for executing queries by using a type system you define for your data. GraphQL isn't tied to any specific database or storage engine and is instead backed by your existing code and data.
\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"d1f1d777-1667-44f5-a271-8471c14ee0a6"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a112e4f8-b378-46f9-8fe0-eb0995280e1b"}}],"_postman_id":"bec1bd8e-a7b0-40e1-9db7-1f6990feec80"},{"name":"Platform REST API","item":[{"name":"platform","item":[{"name":"v2","item":[{"name":"associationconfigurationcontainers","item":[{"name":"Association Configuration Containers Post","id":"221e19a7-c830-4bdd-8185-e1b45aa2c5f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"(Required) access token
\n"},{"key":"Asynchronous","value":"Asynchronous operation
\n"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"id","value":"(This can only be one of 0,1,2,3)
\n"},{"key":"acronym","value":"(This can only be one of 0,5,10)
\n"},{"key":"componentSelfReportingMode","value":"(This can only be one of 0,5,10)
\n"},{"key":"showCertificationsInPortal","value":"(This can only be one of 0,5,10)
\n"},{"key":"resumeSearchFields","value":"[\"(This can only be one of 0,5)
\n"},{"key":"preferredPaymentProvider","value":"(This can only be one of 0,4,5,6)
\n"},{"key":"requireCVVNumber","value":"