¶ Standard agreement certification module

Update Time: 2024-10-10 07:28:40

This module contains authentication of OIDC、OAuth 2.0、SAML、CAS standard protocol, obtains tokens, checking tokens, and logout. The method of initiating authentication needs to be used at the front end, get a token, check the token, and other methods need to be used in the backend.

Instructions:

// Initialize using AppId and appHost
AuthenticationClient authentication = new AuthenticationClient(APP_ID, APP_HOST);

authenticationClient.buildAuthorizeUrl; // Texture front end login link
authenticationClient.getAccessTokenByCode; // Code change Token
authenticationClient.getUserInfoByAccessToken; // Token Change user information
authenticationClient.getNewAccessTokenByRefreshToken; // Refresh Token
authenticationClient.introspectToken; // check Token legality
authenticationClient.revokeToken; // withdraw Token
authenticationClient.validateTicketV1; // Check CAS 1.0 ticket
authenticationClient.buildLogoutUrl; // Texture front end logout link
authenticationClient.getAccessTokenByClientCredentials; // Machine license Access Token

¶ OIDC

OpenID Connect is abbreviated as OIDC, an extension of OAuth 2.0, which mainly adds a semantic user information field.

¶ initialization

Parameters when initializing AuthenticationClient:

appId <String> Apply ID, required.
secret <String> Apply the key, required.
host <String> Apply complete address, such as https://sample-app.authing.cn, not bring the final slash '/'.
redirectUri <String> Business callback URL, required. Please see Document。
protocol <ProtocolEnum> Protocol type, optional value OIDC、OAUTH、SAML、CAS,default is OIDC。
tokenEndPointAuthMethod <AuthMethodEnum> Get the token endpoint Verification Mode, optional value CLIENT_SECRET_POST、CLIENT_SECRET_BASIC、NONE, default is CLIENT_SECRET_POST.
introspectionEndPointAuthMethod <AuthMethodEnum> Check the way to verify the token endpoint, optional value CLIENT_SECRET_POST、CLIENT_SECRET_BASIC、NONE, default is CLIENT_SECRET_POST。
revocationEndPointAuthMethod <AuthMethodEnum> Withdraw the Token Endpoint Validation, optional value is CLIENT_SECRET_POST、CLIENT_SECRET_BASIC、NONE, default is CLIENT_SECRET_POST。

¶ Example

// Initialize using AppId and appHost
AuthenticationClient authentication = new AuthenticationClient(APP_ID, APP_HOST);

// Business callback address
authentication.setRedirectUri(REDIRECT_URI);

authenticationClient.buildAuthorizeUrl(options)

A user login link to generate an OIDC protocol

¶ parameter

options <IOidcParams> Parameters that need to be filled in when launching a license login. Please see Using OIDC Authorization Code Mode.
options.scope <String> Request permission item, option, OIDC protocol default openid profile email phone address OAuth 2.0 protocol defaults user.
options.nonce <String> Random strings, optional, default automatically generated.
options.state <String> Random strings, optional, default automatically generated.
options.responseMode <String> Response type, optional, optional value query、fragment、form_post; default is query, is redirected by the browser to send the Code to the callback address.
options.responseType <String>Response type, optional, optional value code、code id_token token、code id_token、code id_token、code token、id_token token、id_token、none; default is code, Authorize code mode.
options.redirectUri <String> The redirectUri parameter when the callback address, optional, and defaults to SDK initialization.

¶ Example

// Splicing OIDC license link
authenticationClient.setProtocol(ProtocolEnum.OIDC);

IOidcParams iOidcParams = new IOidcParams();

iOidcParams.setRedirectUri("www.xxxxxxx.com");
iOidcParams.setNonce("nonce test");

String oidcString = authenticationClient.buildAuthorizeUrl(iOidcParams);

¶ Sample data

https://oidc1.authing.cn/oidc/auth?nonce=5485323897342262&state=7400704296715694&scope=openid+profile+offline_access&client_id=5f17a529f64fb009b794a2ff&response_mode=query&redirect_uri=https%3A%2F%2Fbaidu.com&response_type=code&prompt=consent

¶ Code change Token

authenticationClient.getAccessTokenByCode(code)

Use the authorization code Code to get the user's Token information.

¶ parameter

code <String> Authorize Code, users have successfully certified, Authing will send the authorization Code to the callback address. Please see Using OIDC Authorization Code Mode.

¶ Example

Object res = authenticationClient.getAccessTokenByCode('授权码 code').execute();

¶ Sample data

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlRmTE90M0xibjhfYThwUk11ZXNzYW1xai1vM0RCQ3MxLW93SExRLVZNcVEifQ.eyJqdGkiOiJsdzg0NW5zdGcwS3EtMTlodVpQOHYiLCJzdWIiOiI1ZmY3MDFkODQ2YjkyMDNlMmY2YWM2ZjMiLCJpYXQiOjE2MTU4ODM1ODYsImV4cCI6MTYxNTg4NzE4Niwic2NvcGUiOiJlbWFpbCBvcGVuaWQgcHJvZmlsZSBwaG9uZSIsImlzcyI6Imh0dHBzOi8vb2lkYzEuYXV0aGluZy5jbi9vaWRjIiwiYXVkIjoiNWYxN2E1MjlmNjRmYjAwOWI3OTRhMmZmIn0.VvYKBcWcr8iIi1b37ugWQ9hsvog4_7EqDQyFqwhIuvM0NHlHH3Bhw83EQIKSNfbWV4nv3ihfeNGPLMzslbQr-wwjnWZTLMYl1bcn7IdVtD_kTN3Zz10MwF5td-VQ7UndU28wJ0HE1mo6E8QH93kYGckS5FSZXmCBa0M5H59Jec_a1MHI1MZrr_V9cZ9EfeF97V-PcqU8JVAwDZclCJ3mWY_Mb65RnMR9yEVqUZzJStmaXGMuRIzjkm2pklqt0CtQQJfzECXq_4USpwRXDiYLWILYPUCcO6hGxDjhMEd8IcxdG51TQP-w1UM6LyIRn61uSJvDsz8zg5dStDKyocypiA",
  "expires_in": 3600,
  "id_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InRlc3QzQDEyMy5jb20iLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsInN1YiI6IjVmZjcwMWQ4NDZiOTIwM2UyZjZhYzZmMyIsImJpcnRoZGF0ZSI6bnVsbCwiZmFtaWx5X25hbWUiOm51bGwsImdlbmRlciI6IlUiLCJnaXZlbl9uYW1lIjpudWxsLCJsb2NhbGUiOm51bGwsIm1pZGRsZV9uYW1lIjpudWxsLCJuYW1lIjpudWxsLCJuaWNrbmFtZSI6bnVsbCwicGljdHVyZSI6Imh0dHBzOi8vZmlsZXMuYXV0aGluZy5jby9hdXRoaW5nLWNvbnNvbGUvZGVmYXVsdC11c2VyLWF2YXRhci5wbmciLCJwcmVmZXJyZWRfdXNlcm5hbWUiOm51bGwsInByb2ZpbGUiOm51bGwsInVwZGF0ZWRfYXQiOiIyMDIxLTAzLTE1VDA1OjU0OjU0LjY4NVoiLCJ3ZWJzaXRlIjpudWxsLCJ6b25laW5mbyI6bnVsbCwicGhvbmVfbnVtYmVyIjpudWxsLCJwaG9uZV9udW1iZXJfdmVyaWZpZWQiOmZhbHNlLCJub25jZSI6IjcwVEU3eW9NVFEiLCJhdF9oYXNoIjoiUFNnOGw5eDRldGxmLXA4UDdjYnVoQSIsImlzcyI6Imh0dHBzOi8vb2lkYzEuYXV0aGluZy5jbi9vaWRjIiwiaXNzMiI6Imh0dHBzOi8vYmFpZHUuY29tIiwiYXVkIjoiNWYxN2E1MjlmNjRmYjAwOWI3OTRhMmZmIiwiZXhwIjoxNjE1ODg3MTg3LCJpYXQiOjE2MTU4ODM1ODh9.OlX-FP7znIEqx0YpnOQ8kxadMe1toHDj1KPVm0dbEVc",
  "scope": "email openid profile phone",
  "token_type": "Bearer"
}

Field Explanation:

Field name	meaning
token_type	Token Type, fixed value Bearer
scope	Wheelcence, authorized acquisition items
id_token	Id token，Authing Issued Id token
expires_in	Access token Expiration
access_token	Access token，Authing Issued Access token

¶ Token Change user information

authenticationClient.getUserInfoByAccessToken('access_token')

Use Access token to get user information.

¶ parameter

access_token <String> Access token, use the contents of Access token with the authorization code code. Please see Using OIDC Authorization Code Mode.

¶ Example

Object res = authenticationClient.getUserInfoByAccessToken('Access token').execute();

¶ Sample data

{
  "address": {
    "country": null,
    "postal_code": null,
    "region": null,
    "formatted": null
  },
  "birthdate": null,
  "family_name": null,
  "gender": "U",
  "given_name": null,
  "locale": null,
  "middle_name": null,
  "name": null,
  "nickname": null,
  "picture": "https://files.authing.co/authing-console/default-user-avatar.png",
  "preferred_username": null,
  "profile": null,
  "updated_at": "2021-03-03T06:17:14.485Z",
  "website": null,
  "zoneinfo": null,
  "email": "test1@authing.cn",
  "email_verified": false,
  "sub": "603f184cec4505e2868431fc",
  "phone_number": null,
  "phone_number_verified": false
}

Field Explanation:

Field name	translation
sub	Subject's abbreviation, unique identifier, generally user ID
name	name
given_name	given name
family_name	family name
middle_name	middle name
nickname	nickname
preferred_username	preferred username
profile	Basic information
picture	Avatar
website	website
email	E-mail
email_verified	Whether the mailbox is certified
gender	gender
birthdate	birthdate
zoneinfo	Time zone
locale	area
phone_number	phone number
phone_number_verified	Certified mobile phone number
address	Address object
address.formatted	Address
address.street_address	Street address
address.locality	city
address.region	region
address.postal_code	postal code
address.country	country
updated_at	Information update time

¶ Refresh Access Token

authenticationClient.getNewAccessTokenByRefreshToken(refreshToken)

Get new Access Token with Refresh token.

¶ parameter

refreshToken <String> Refresh token, you can get refresh_token form the return value of authenticationClient.getAccessTokenByCode.For details, please see Refreshing Access token。

¶ Example

Object res = authenticationClient.getNewAccessTokenByRefreshToken('Access token').execute();

¶ Sample data

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlRmTE90M0xibjhfYThwUk11ZXNzYW1xai1vM0RCQ3MxLW93SExRLVZNcVEifQ.eyJqdGkiOiJZUHB4NUVEWGlQWVJvNUFQWXAzci0iLCJzdWIiOiI1ZmY3MDFkODQ2YjkyMDNlMmY2YWM2ZjMiLCJpYXQiOjE2MTQwOTE0OTksImV4cCI6MTYxNDA5NTA5OSwic2NvcGUiOiJvZmZsaW5lX2FjY2VzcyBwcm9maWxlIG9wZW5pZCIsImlzcyI6Imh0dHBzOi8vb2lkYzEuYXV0aGluZy5jbi9vaWRjIiwiYXVkIjoiNWYxN2E1MjlmNjRmYjAwOWI3OTRhMmZmIn0.ZN_SlfVg1oNMz7uAK-5K84dqqqmlZehmAPOLytOR9HnLHImKJ9VO5u1hRsAjGCob0kMUV5wVxQhX3EFks7FtMamiX2Jvn-NYh4V_5T6l3LFf4uoKF6AykAg483nG3EEENuGgQo15bBszsoCGqFnNmUd0T4Cgxx0zbxXPxMdp_dcE14KzmNz1w-Qg3yVeYmSTZFdcLtZA2BYnVEa7LYA2yA3DgawwAcRmrlyEfnvCO3uY2TcsTKEAfQ-QgVIGRWOfyUE5f-_X3TolliO1fXnwZBdxEKMXLGW5E2bPVcePyiV0upYbUnQ079UxBlEiWlgeW_rpkTPXDxHAgiE488gtlg",
  "expires_in": 3600,
  "id_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1ZmY3MDFkODQ2YjkyMDNlMmY2YWM2ZjMiLCJiaXJ0aGRhdGUiOm51bGwsImZhbWlseV9uYW1lIjpudWxsLCJnZW5kZXIiOiJVIiwiZ2l2ZW5fbmFtZSI6bnVsbCwibG9jYWxlIjpudWxsLCJtaWRkbGVfbmFtZSI6bnVsbCwibmFtZSI6bnVsbCwibmlja25hbWUiOm51bGwsInBpY3R1cmUiOiJodHRwczovL2ZpbGVzLmF1dGhpbmcuY28vYXV0aGluZy1jb25zb2xlL2RlZmF1bHQtdXNlci1hdmF0YXIucG5nIiwicHJlZmVycmVkX3VzZXJuYW1lIjpudWxsLCJwcm9maWxlIjpudWxsLCJ1cGRhdGVkX2F0IjoiMjAyMS0wMi0yM1QxNDo0NDoxOC4wODVaIiwid2Vic2l0ZSI6bnVsbCwiem9uZWluZm8iOm51bGwsImF0X2hhc2giOiIxaWRJSUxaWExpZkRscXJMY3ZNeV9BIiwiS0VZIjoiVkFMVUUiLCJhdWQiOiI1ZjE3YTUyOWY2NGZiMDA5Yjc5NGEyZmYiLCJleHAiOjE2MTQwOTUwOTgsImlhdCI6MTYxNDA5MTQ5OSwiaXNzIjoiaHR0cHM6Ly9vaWRjMS5hdXRoaW5nLmNuL29pZGMifQ._H59237sqpsY0OgyY_RM7CvuG6cFo1x03y-DBhd5hik",
  "refresh_token": "3T49f4Y48szoMmwBXragjqLwQZC4QhgnsM5Oy2WfmU-",
  "scope": "openid offline_access profile",
  "token_type": "Bearer"
}

¶ Check Access Token

authenticationClient.introspectToken(token)

Check Access token or Refresh token status.

¶ parameter

token <String> Access token or Refresh token, you can get access_token、refresh_token form the return value of authenticationClient.getAccessTokenByCode.

¶ Example

Object res = authenticationClient.introspectToken('Access token or Refresh token').execute();

¶ Sample data

Token is returned when returning:

{
  "active": true,
  "sub": "60097f4d5bc08f75da104d18",
  "client_id": "60097391b1358c17c5fb0f4e",
  "exp": 1612445888,
  "iat": 1611236288,
  "iss": "https://core.littleimp.cn/oidc",
  "jti": "TV4J0gAbe4KR4-8CtYcOa",
  "scope": "openid profile email phone offline_access",
  "token_type": "Bearer"
}

Token returns when it is not legal:

{
  "active": false
}

The test process fails will throw an error.

¶ Check Id Token legality

authenticationClient.validateToken(param)

Online Interface Verify ID token or Access Token via Authing. A network request will be generated.

¶ parameter

param <ValidateTokenParams>
param.dToken <String> Access token or Refresh token, you can get id_token form the return value of authenticationClient.getAccessTokenByCode.
param.accessToken <String> Access token, you can get access_token form the return value of authenticationClient.getAccessTokenByCode.

¶ Example

ValidateTokenParams params = new ValidateTokenParams();

params.setAccessToken("Access Token");

Object res = authenticationClient.validateToken(params).execute();

¶ Sample data

id_token Returns when verify:

{
  "sub": "5f64afd1ad501364e3b43c1e",
  "birthdate": null,
  "family_name": null,
  "gender": "U",
  "given_name": null,
  "locale": null,
  "middle_name": null,
  "name": null,
  "nickname": null,
  "picture": "https://usercontents.authing.cn/authing-avatar.png",
  "preferred_username": "test1",
  "profile": null,
  "updated_at": "2020-09-27T06:06:29.853Z",
  "website": null,
  "zoneinfo": null,
  "email": "test1@123.com",
  "email_verified": false,
  "phone_number": null,
  "phone_number_verified": false,
  "nonce": "CQsguqUdl7",
  "at_hash": "10iOtwuTNtyQLzlNYXAHeg",
  "aud": "5f17a529f64fb009b794a2ff",
  "exp": 1601460494,
  "iat": 1601456894,
  "iss": "https://oidc1.authing.cn/oidc"
}

Id token returns the illegal time:

{ "code": 400, "message": "id_token format is incorrect" }

{ "code": 400, "message": "id_token illegal" }

Access token returns when verifying:

{
  "jti": "K5TYewNhvdGBdHiRifMyW",
  "sub": "5f64afd1ad501364e3b43c1e", // subject 的缩写，为用户 ID
  "iat": 1601456894,
  "exp": 1601460494,
  "scope": "openid profile email phone",
  "iss": "https://oidc1.authing.cn/oidc",
  "aud": "5f17a529f64fb009b794a2ff"
}

Access token returns the illegal time:

{ "code": 400, "message": "access_token format is incorrect" }

{ "code": 400, "message": "access_token illegal" }

¶ Client Credentials get Access Token

authenticationClient.getAccessTokenByClientCredentials(scope, options)

Use Programming Access AccountGet Access Token with permissions.

¶ parameter

scope <String> Permission items, space separated strings, each represents a permission. Please see Machine (M2M) Authorization.
options <ClientCredentialInput> Programming Access AK and SK information.
options.accessKey <String> Programming Access Account AccessKey.
options.secretKey <String> Programming Access Account SecretKey.

¶ Example

 ClientCredentialInput clientCredentialInput = new ClientCredentialInput("60519949a70e7dda12785693"
                , "be1a5596b3185d88c097ae310e3184ed");

Object res = testAC.getAccessTokenByClientCredentials("testr2", clientCredentialInput).execute();

¶ Sample data

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlRmTE90M0xibjhfYThwUk11ZXNzYW1xai1vM0RCQ3MxLW93SExRLVZNcVEifQ.eyJqdGkiOiJsdzg0NW5zdGcwS3EtMTlodVpQOHYiLCJzdWIiOiI1ZmY3MDFkODQ2YjkyMDNlMmY2YWM2ZjMiLCJpYXQiOjE2MTU4ODM1ODYsImV4cCI6MTYxNTg4NzE4Niwic2NvcGUiOiJlbWFpbCBvcGVuaWQgcHJvZmlsZSBwaG9uZSIsImlzcyI6Imh0dHBzOi8vb2lkYzEuYXV0aGluZy5jbi9vaWRjIiwiYXVkIjoiNWYxN2E1MjlmNjRmYjAwOWI3OTRhMmZmIn0.VvYKBcWcr8iIi1b37ugWQ9hsvog4_7EqDQyFqwhIuvM0NHlHH3Bhw83EQIKSNfbWV4nv3ihfeNGPLMzslbQr-wwjnWZTLMYl1bcn7IdVtD_kTN3Zz10MwF5td-VQ7UndU28wJ0HE1mo6E8QH93kYGckS5FSZXmCBa0M5H59Jec_a1MHI1MZrr_V9cZ9EfeF97V-PcqU8JVAwDZclCJ3mWY_Mb65RnMR9yEVqUZzJStmaXGMuRIzjkm2pklqt0CtQQJfzECXq_4USpwRXDiYLWILYPUCcO6hGxDjhMEd8IcxdG51TQP-w1UM6LyIRn61uSJvDsz8zg5dStDKyocypiA",
  "expires_in": 3600,
  "scope": "email openid profile phone",
  "token_type": "Bearer"
}

¶ OAuth 2.0

OAuth is an open network standard for authorization (Authorization), the current version is version 2.0.

¶ initialization

Parameters when initializing AuthenticationClient:

appId <String> Apply ID, required.
secret <String> Apply the key, required.
host <String> Apply the full address, such as https://sample-app.authing.cn, without the last slash '/'.
redirectUri <String> Business callback URL, mustal. Please see Document.
protocol <ProtocolEnum> Protocol type, optional value OIDC、OAUTH、SAML、CAS, default is OIDC.
tokenEndPointAuthMethod <AuthMethodEnum> Get the Token endpoint Verification Mode, optional value CLIENT_SECRET_POST、CLIENT_SECRET_BASIC、NONE, default is CLIENT_SECRET_POST.
introspectionEndPointAuthMethod <AuthMethodEnum> Check the way to verify the Token Endpoint, optional value CLIENT_SECRET_POST、CLIENT_SECRET_BASIC、NONE, default is CLIENT_SECRET_POST.
revocationEndPointAuthMethod <AuthMethodEnum> Withdraw the Token Endpoint Validation, optional value is CLIENT_SECRET_POST、CLIENT_SECRET_BASIC、NONE, default is CLIENT_SECRET_POST.

¶ Example

// Initialize using AppId and appHost
AuthenticationClient authentication = new AuthenticationClient(APP_ID, APP_HOST);

// Business callback address
authentication.setRedirectUri(REDIRECT_URI);

authenticationClient.buildAuthorizeUrl(options)

User login link to generate OAuth 2.0 protocol

¶ parameter

options <IOauthParams> Parameters that need to be filled in when launching a license login. Please see Use OAuth2.0 Authorized Code Mode.
options.scope <String> Request permission item, option, OIDC protocol default openid profile email phone address，OAuth 2.0 protocol is default user.
options.state <String> Random strings, optional, default automatically generated.
options.responseType <String> Response type, optional, optional value code、token default is code, Authorize code mode.
options.redirectUri <String> The redirectUri parameter when the callback address, optional, and defaults to SDK initialization.

¶ Example

authenticationClient.setProtocol(ProtocolEnum.OAUTH);

IOauthParams iOauthParams = new IOauthParams();

iOauthParams.setRedirectUri("www.xxxxx.com");

String oauthString = authenticationClient.buildAuthorizeUrl(iOauthParams);

¶ Sample data

https://oidc1.authing.cn/oauth/auth?state=7400704296715694&scope=user&client_id=5f17a529f64fb009b794a2ff&redirect_uri=https%3A%2F%2Fbaidu.com&response_type=code

¶ Code change Token

authenticationClient.getAccessTokenByCode(code)

Use the authorization code Code to get the user's token information.

¶ parameter

code <String> Authorize code CODE, the user will send the authorization code code to the callback address after the authentication is successful. Please see Use OAuth 2.0 Authorization Code Mode.

¶ Example

Object res = authenticationClient.getAccessTokenByCode('授权码 code').execute();

¶ Sample data

{
  "access_token": "fa9d2bdd914ea01aa4e434c12d4f919d749fc75c",
  "token_type": "Bearer",
  "expires_in": 1209599,
  "refresh_token": "b5e0e1afe793c6634495434afc262b88ddee9af3",
  "scope": "user"
}

Field Explanation:

Field name	meaning
token_type	Token Type, fixed value Bearer
scope	Wheelcence, authorized acquisition items
expires_in	Access token Expiration
access_token	Access token，Authing Issued Access token

¶ Token for user information

authenticationClient.getUserInfoByAccessToken('access_token')

Use Access token to get user information.

¶ parameter

access_token <String> Access Token, use the authorization code Code changed Access token's contents. Please see Use OAuth 2.0 Authorization Code Mode.

¶ Example

Object res = authenticationClient.getUserInfoByAccessToken('Access token').execute();

¶ Sample data

{
  "address": {
    "country": null,
    "postal_code": null,
    "region": null,
    "formatted": null
  },
  "birthdate": null,
  "family_name": null,
  "gender": "U",
  "given_name": null,
  "locale": null,
  "middle_name": null,
  "name": null,
  "nickname": null,
  "picture": "https://files.authing.co/authing-console/default-user-avatar.png",
  "preferred_username": null,
  "profile": null,
  "updated_at": "2021-03-03T06:17:14.485Z",
  "website": null,
  "zoneinfo": null,
  "email": "test1@authing.cn",
  "email_verified": false,
  "sub": "603f184cec4505e2868431fc",
  "phone_number": null,
  "phone_number_verified": false
}

Field Explanation:

Field name	translation
sub	Subject's abbreviation, unique identifier, generally user ID
name	name
given_name	given name
family_name	family name
middle_name	middle name
nickname	nickname
preferred_username	preferred username
profile	Basic information
picture	Avatar
website	website
email	E-mail
email_verified	Whether the mailbox is certified
gender	gender
birthdate	birthdate
zoneinfo	Time zone
locale	area
phone_number	phone number
phone_number_verified	Certified mobile phone number
address	Address object
address.formatted	Address
address.street_address	Street address
address.locality	city
address.region	region
address.postal_code	postal code
address.country	country
updated_at	Information update time

¶ Refresh Access Token

authenticationClient.getNewAccessTokenByRefreshToken(refreshToken)

Use Refresh token get new Access token.

¶ parameter

refreshToken <String> Refresh token, you can get refresh_token from the return value of authenticationClient.getAccessTokenByCode.

¶ Example

Object res = authenticationClient.getNewAccessTokenByRefreshToken('Access token').execute();

¶ Sample data

{
  "access_token": "fa9d2bdd914ea01aa4e434c12d4f919d749fc75c",
  "token_type": "Bearer",
  "expires_in": 1209599,
  "refresh_token": "b5e0e1afe793c6634495434afc262b88ddee9af3",
  "scope": "user"
}

¶ Check Access Token

authenticationClient.introspectToken(token)

Check Access token or Refresh token status.

¶ parameter

token <String> Access token or Refresh token, you can get access_token、refresh_token from the return value of authenticationClient.getAccessTokenByCode.

¶ Example

Object res = authenticationClient.introspectToken('Access token 或 Refresh token').execute();

¶ Sample data

Token returns when legal:

{
  "active": true,
  "sub": "5f719946524ee1099229496b", // subject 的缩写，为用户 ID
  "client_id": "5f17a529f64fb009b794a2ff",
  "exp": 1619083024,
  "iat": 1617873424,
  "iss": "https://core.authing.cn/oauth",
  "jti": "qbovGK-HZL0O_20wY7uXj",
  "scope": "user",
  "token_type": "Bearer"
}

Token returns when not legal:

{
  "active": false
}

The test process fails will throw an error.

¶ SAML2

Security Assertion Markup Language is an XML-based open source standard data format, which exchange authentication and authorization data between the parties, especially in identity providers. Switch between service providers.

¶ initialization

Parameters when initializing AuthenticationClient:

appId <String> Apply ID, required.
appHost <String> Apply the full address, such as https://sample-app.authing.cn, without the last slash '/'.
protocol <ProtocolEnum> Protocol type, optional value OIDC、OAUTH、SAML、CAS,the default is OIDC.

¶ Example

// Initialize using AppId and appHost
AuthenticationClient authentication = new AuthenticationClient(APP_ID, APP_HOST);

// Business callback address
authentication.setRedirectUri(REDIRECT_URI);

authenticationClient.buildAuthorizeUrl()

User login link to generate SAML2 protocol

¶ parameter

¶ Example

// Splicing SAML2 login link
authenticationClient.setProtocol(ProtocolEnum.SAML);

String samlString = authenticationClient.buildAuthorizeUrl();

¶ Sample data

https://oidc1.authing.cn/api/v2/saml-idp/5f17a529f64fb009b794a2ff

¶ CAS

CAS is the abbreviation of the Central Authentication Service, a central authentication service, an independent open instruction protocol.

¶ initialization

Parameters when initializing AuthenticationClient:

appId <String> Apply ID, required.
appHost <String> Apply the full address, such as https://sample-app.authing.cn, without the last slash '/'.
protocol <ProtocolEnum> Protocol type, optional value OIDC、OAUTH、SAML、CAS, the default is OIDC。

¶ Example

// Initialize using AppId and appHost
AuthenticationClient authentication = new AuthenticationClient(APP_ID, APP_HOST);

// Business callback address
authentication.setRedirectUri(REDIRECT_URI);

authenticationClient.buildAuthorizeUrl(options)

User login link to generate a CAS protocol

¶ parameter

options <object> Parameters that need to be filled in when launching a license login.
options.service <String> Business callback address in the CAS protocol.

¶ Example

// Splicing CAS login link
authenticationClient.setProtocol(ProtocolEnum.CAS);

ICasParams iCasParams = new ICasParams();

iCasParams.setService("service txt");

String casString = authenticationClient.buildAuthorizeUrl(iCasParams);

¶ Sample data

https://oidc1.authing.cn/cas-idp/5f17a529f64fb009b794a2ff/login?service=https://example.com

Prev: Certified core module Next: Management Module

¶ Standard agreement certification module

¶ OIDC

¶ initialization

¶ Example

¶ A user login link to generate an OIDC protocol

¶ parameter

¶ Example

¶ Sample data

¶ Code change Token

¶ parameter

¶ Example

¶ Sample data

¶ Token Change user information

¶ parameter

¶ Example

¶ Sample data

¶ Refresh Access Token

¶ parameter

¶ Example

¶ Sample data

¶ Check Access Token

¶ parameter

¶ Example

¶ Sample data

¶ Check Id Token legality

¶ parameter

¶ Example

¶ Sample data

¶ Client Credentials get Access Token

¶ parameter

¶ Example

¶ Sample data

¶ OAuth 2.0

¶ initialization

¶ Example

¶ User login link to generate OAuth 2.0 protocol

¶ parameter

¶ Example

¶ Sample data

¶ Code change Token

¶ parameter

¶ Example

¶ Sample data

¶ Token for user information

¶ parameter

¶ Example

¶ Sample data

¶ Refresh Access Token

¶ parameter

¶ Example

¶ Sample data

¶ Check Access Token

¶ parameter

¶ Example

¶ Sample data

¶ SAML2

¶ initialization

¶ Example

¶ User login link to generate SAML2 protocol

¶ parameter

¶ Example

¶ Sample data

¶ CAS

¶ initialization

¶ Example

¶ User login link to generate a CAS protocol

¶ parameter

¶ Example

¶ Sample data