{"id":16998499,"url":"https://github.com/cooperlyt/keycloakphoneclient","last_synced_at":"2025-08-14T07:46:06.093Z","repository":{"id":148502664,"uuid":"326330146","full_name":"cooperlyt/KeycloakPhoneClient","owner":"cooperlyt","description":"keycloak phone client sample for android ","archived":false,"fork":false,"pushed_at":"2024-02-13T21:31:30.000Z","size":151,"stargazers_count":9,"open_issues_count":1,"forks_count":6,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-16T00:03:03.412Z","etag":null,"topics":["android","client","keycloak","phone","sms"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cooperlyt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2021-01-03T04:52:31.000Z","updated_at":"2024-12-23T12:05:54.000Z","dependencies_parsed_at":"2023-09-16T11:20:30.927Z","dependency_job_id":null,"html_url":"https://github.com/cooperlyt/KeycloakPhoneClient","commit_stats":null,"previous_names":["cooperlyt/keycloakphoneclient"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cooperlyt%2FKeycloakPhoneClient","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cooperlyt%2FKeycloakPhoneClient/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cooperlyt%2FKeycloakPhoneClient/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cooperlyt%2FKeycloakPhoneClient/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cooperlyt","download_url":"https://codeload.github.com/cooperlyt/KeycloakPhoneClient/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249173084,"owners_count":21224483,"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":["android","client","keycloak","phone","sms"],"created_at":"2024-10-14T04:05:25.693Z","updated_at":"2025-04-16T00:03:18.227Z","avatar_url":"https://github.com/cooperlyt.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Keycloak phone client\n\n+ login and get token from keycloak\n+ add token to http header, access protected resource\n+ auto refresh token\n\nif you need phone support for keycloak , try my\nproject: [keycloak-phone-provider](https://github.com/cooper-lyt/keycloak-phone-provider), this sample is base\non: [keycloak-phone-provider](https://github.com/cooper-lyt/keycloak-phone-provider). this sample is android client,\nnothing stop you from implementing other java program.\n\n## Usage\n\ncopy keycloak-client to your project\n\n**Initialize:**\n\n```java\n\naccessTokenHolder=new KeycloakTokenHolder.Builder()\n        .host(\"www.XXX.com\") // root address: like \"www.XXX.com\"\n        .realms(\"realms\")  // realms: config in your keycloak\n        .clientId(\"clientId\") // clientId: config in your keycloak\n        .clientSecret(\"XXXX-XXXX-XXXX-XXXX-XXXXXXXXXX\") //clientSecret : clientId: config in your keycloak\n        .storage(new SharedPreferencesStorage(getSharedPreferences(\"keycloak-sample\",Context.MODE_PRIVATE),ACCESS_TOKEN_STORE_KEY)) // storage: you can custom for cc.coopersoft.accesstoken.keycloak.KeycloakTokenStorage\n        .build();\n\n```\n\nstorage: you can custom storage from KeycloakTokenStorage, in my project ,i use tencent mmkv.\n\n**Login:**\n\n1. Required auth code\n\n```java\n\nKeycloakClient.accessTokenHolder().sendAuthenticationCode(binding.phoneNumber.getText().toString(),new CodeRequestCallback(){\n@Override\npublic void onFailure(String phoneNumber,ErrorResult error){\n        binding.requestAuthCode.setEnabled(true);\n        runOnUiThread(()-\u003etoast(\"send code fail!\"));\n        }\n\n@Override\npublic void onSuccess(String phoneNumber,Result result){\n        Looper.prepare();\n        new CountDownTimer(result.getExpiresIn()*1000,1000){\n@Override\npublic void onTick(long millisUntilFinished){\n        binding.requestAuthCode.setEnabled(false);\n        binding.requestAuthCode.setText(\"send(\"+millisUntilFinished/1000+\")\");\n\n        }\n\n@Override\npublic void onFinish(){\n        binding.requestAuthCode.setEnabled(true);\n        binding.requestAuthCode.setText(\"resend\");\n\n        }\n        }.start();\n        Looper.loop();\n        }\n        });\n\n```\n\n2. Required token\n\n```java\n      KeycloakClient.accessTokenHolder().requireToken(PhoneCredential.builder().phone(phone).code(code).build(), new AuthenticationCallback() {\n\n        @Override\n        public void onFailure(ErrorResult error) {\n          runOnUiThread(() -\u003e toast(\"login fail!\"));\n          loading(false);\n        }\n\n        @Override\n        public void onSuccess() {\n          MainActivity.start(LoginActivity.this);\n          finish();\n        }\n      });\n```\n\n\n**Access protected resource:**\n\n```java\nokHttpClientBuilder.addInterceptor(new AllAccessTokenInterceptor());\n```\n\nabout Interceptor:\n + AllAccessTokenInterceptor \n + WhiteAccessTokenInterceptor\n + you can custom Interceptor on AccessTokenInterceptor\n\nin my project, I use Retrofit implement a dynamic Interceptor annotation like this:\n\n```java\n\n  @POST(\"pyramid/task/receive/{id}\")\n  @RequireInterceptor({\"accessToken\"})\n  Observable\u003cUser\u003e receive(@Path(\"id\") int id);\n\n```\n\n**Token auth refresh:**\n\n1. auto refresh on token is expires.\n2. auto refresh on http required first return 401.\n3. refreshToke is expires, return 401.\n\n**verification phone number:**\n\n1. Required verification code\n\n```java\n      KeycloakClient.accessTokenHolder().sendVerificationCode(binding.phoneNumber.getText().toString(), new CodeRequestCallback() {\n        @Override\n        public void onFailure(String phoneNumber, ErrorResult error) {\n          binding.requestAuthCode.setEnabled(true);\n          runOnUiThread(()-\u003e toast(\"send code fail!\"));\n        }\n\n        @Override\n        public void onSuccess(String phoneNumber, Result result) {\n          Looper.prepare();\n          new CountDownTimer(result.getExpiresIn() * 1000, 1000) {\n            @Override\n            public void onTick(long millisUntilFinished) {\n              binding.requestAuthCode.setEnabled(false);\n              binding.requestAuthCode.setText(\"send(\" + millisUntilFinished / 1000 + \")\");\n\n            }\n\n            @Override\n            public void onFinish() {\n              binding.requestAuthCode.setEnabled(true);\n              binding.requestAuthCode.setText(\"resend\");\n\n            }\n          }.start();\n          Looper.loop();\n        }\n      });\n```\n\n2. valid code\n\n```java\nKeycloakClient.accessTokenHolder().verificationCode(binding.phoneNumber.getText().toString(), binding.authCode.getText().toString(), new VerificationCallback() {\n        @Override\n        public void onError(String phoneNumber, ErrorResult error) {\n          runOnUiThread(()-\u003e toast(\"valid fail!\" + error.getErrorDescription()));\n        }\n\n        @Override\n        public void onFailure(String phoneNumber) {\n          runOnUiThread(()-\u003e toast(\"valid fail!\"));\n        }\n\n        @Override\n        public void onSuccess(String phoneNumber) {\n          runOnUiThread(()-\u003e toast(\"valid success\"));\n        }\n      });\n```\n\n**logout (clear token):**\n\n```java\n  KeycloakClient.accessTokenHolder().clearToken();\n```\n\n**other:**\n look for PhoneSupportAccessTokenHolder.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcooperlyt%2Fkeycloakphoneclient","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcooperlyt%2Fkeycloakphoneclient","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcooperlyt%2Fkeycloakphoneclient/lists"}