{"id":26068298,"url":"https://github.com/ssoready/ssoready-java","last_synced_at":"2026-02-03T00:41:21.745Z","repository":{"id":268570013,"uuid":"870919314","full_name":"ssoready/ssoready-java","owner":"ssoready","description":"Java SDK for SSOReady. Add SAML + SCIM support to any Java application this afternoon.","archived":false,"fork":false,"pushed_at":"2024-12-05T19:32:47.000Z","size":108,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-25T14:03:45.518Z","etag":null,"topics":["java","saml","scim","sso"],"latest_commit_sha":null,"homepage":"https://ssoready.com","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ssoready.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-10T23:04:24.000Z","updated_at":"2024-12-05T19:42:00.000Z","dependencies_parsed_at":"2024-12-17T15:47:35.210Z","dependency_job_id":"f43d6049-3a10-4f05-8b42-5094b809060a","html_url":"https://github.com/ssoready/ssoready-java","commit_stats":null,"previous_names":["ssoready/ssoready-java"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ssoready%2Fssoready-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ssoready%2Fssoready-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ssoready%2Fssoready-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ssoready%2Fssoready-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ssoready","download_url":"https://codeload.github.com/ssoready/ssoready-java/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248456370,"owners_count":21106603,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["java","saml","scim","sso"],"created_at":"2025-03-08T22:23:36.356Z","updated_at":"2026-02-03T00:41:21.674Z","avatar_url":"https://github.com/ssoready.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"![](https://i.imgur.com/OhtkhbJ.png)\n\n# SSOReady-Java: SAML \u0026 SCIM for Java\n\n[![](https://img.shields.io/maven-central/v/com.ssoready/ssoready-java)](https://central.sonatype.com/artifact/com.ssoready/ssoready-java)\n\n`com.ssoready:ssoready-java` is a Java SDK for the [SSOReady](https://ssoready.com) API.\n\nSSOReady is a set of open-source dev tools for implementing Enterprise SSO. You\ncan use SSOReady to add SAML and SCIM support to your product this afternoon.\n\nFor example applications built using SSOReady-Java, check out:\n\n- [SSOReady Example App: Java Spring Boot with SAML](https://github.com/ssoready/ssoready-example-app-java-spring-boot-saml)\n\n## Installation\n\nWith `build.gradle`:\n\n```groovy\ndependencies {\n    implementation 'com.ssoready:ssoready-java:1.0.0'\n}\n```\n\nWith `pom.xml`:\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.ssoready\u003c/groupId\u003e\n    \u003cartifactId\u003essoready-java\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n## Usage\n\nThis section provides a high-level overview of how SSOReady works, and how it's\npossible to implement SAML and SCIM in just an afternoon. For a more thorough\nintroduction, visit the [SAML\nquickstart](https://ssoready.com/docs/saml/saml-quickstart) or the [SCIM\nquickstart](https://ssoready.com/docs/scim/scim-quickstart).\n\nThe first thing you'll do is create a SSOReady client instance:\n\n```java\nimport com.ssoready.api.SSOReady;\n\n// this loads your SSOReady API key from SSOREADY_API_KEY\nSSOReady ssoready = SSOReady.builder().build();\n```\n\n### SAML in two lines of code\n\nSAML (aka \"Enterprise SSO\") consists of two steps: an _initiation_ step where\nyou redirect your users to their corporate identity provider, and a _handling_\nstep where you log them in once you know who they are.\n\nTo initiate logins, you'll use SSOReady's [Get SAML Redirect\nURL](https://ssoready.com/docs/api-reference/saml/get-saml-redirect-url)\nendpoint:\n\n```java\n// this is how you implement a \"Sign in with SSO\" button\nString redirectUrl = ssoready.saml().getSamlRedirectUrl(\n    GetSamlRedirectUrlRequest\n        .builder()\n        // the ID of the organization/workspace/team (whatever you call it)\n        // you want to log the user into\n        .organizationExternalId(email.split(\"@\")[1])\n        .build()\n    ).getRedirectUrl().orElseThrow();\n\n// redirect the user to `redirectUrl`...\n```\n\nYou can use whatever your preferred ID is for organizations (you might call them\n\"workspaces\" or \"teams\") as your `organizationExternalId`. You configure those\nIDs inside SSOReady, and SSOReady handles keeping track of that organization's\nSAML and SCIM settings.\n\nTo handle logins, you'll use SSOReady's [Redeem SAML Access\nCode](https://ssoready.com/docs/api-reference/saml/redeem-saml-access-code) endpoint:\n\n```java\n// this goes in your handler for POST /ssoready-callback\nRedeemSamlAccessCodeResponse redeemResponse = this.ssoready.saml().redeemSamlAccessCode(\n    RedeemSamlAccessCodeRequest\n        .builder()\n        .samlAccessCode(\"saml_access_code_...\")\n        .build()\n);\n\n// log the user in as `redeemResponse.getEmail()` inside `redeemResponse.getOrganizationExternalId()`...\n```\n\nYou configure the URL for your `/ssoready-callback` endpoint in SSOReady.\n\n### SCIM in one line of code\n\nSCIM (aka \"Enterprise directory sync\") is basically a way for you to get a list\nof your customer's employees offline.\n\nTo get a customer's employees, you'll use SSOReady's [List SCIM\nUsers](https://ssoready.com/docs/api-reference/scim/list-scim-users) endpoint:\n\n```java\nListScimUsersResponse listScimUsersResponse = ssoready.scim().listScimUsers(\n    ScimListScimUsersRequest\n        .builder()\n        .organizationExternalId(\"...\")\n        .build()\n);\n\n// create users from each scimUser\nfor (ScimUser scimUser : listScimUsersResponse.getScimUsers().orElseThrow()) {\n    // every scimUser has getId(), getEmail(), getAttributes(), and getDeleted()\n    scimUser.getEmail();\n}\n```\n\n## Contributing\n\nIssues and PRs are more than welcome. Be advised that this library is largely\nautogenerated from [`ssoready/docs`](https://github.com/ssoready/docs). Most\ncode changes ultimately need to be made there, not on this repo.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fssoready%2Fssoready-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fssoready%2Fssoready-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fssoready%2Fssoready-java/lists"}