Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Deprecate Legacy Authentication APIs #391

Merged
merged 4 commits into from
Dec 17, 2020
Merged

Deprecate Legacy Authentication APIs #391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
965fb88
Deprecate legacy authentication APIs
jimmyjames Dec 16, 2020
fc2426b
Add addtional deprecations
jimmyjames Dec 17, 2020
55d29f8
Incorporate review comments, fix JavaDoc links
jimmyjames Dec 17, 2020
8d6f28d
Update auth0/src/main/java/com/auth0/android/request/internal/BaseAut…
jimmyjames Dec 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions auth0/src/main/java/com/auth0/android/authentication/AuthenticationAPIClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,8 +306,15 @@ public AuthRequest loginWithOTP(@NonNull String mfaToken, @NonNull String otp) {
* @param token obtained from the IdP
* @param connection that will be used to authenticate the user, e.g. 'facebook'
* @return a request to configure and start that will yield {@link Credentials}
* @deprecated The ability to exchange a third-party provider access token for Auth0 access tokens
* is part of the <a href="https://auth0.com/docs/api/authentication#social-with-provider-s-access-token">/oauth/access_token</a>
* Authentication API legacy endpoint, disabled as of June 2017. For selected social providers,
* there's support for a similar token exchange using the <a href="https://auth0.com/docs/api/authentication#token-exchange-for-native-social">Native Social token exchange</a>
* endpoint, using {@linkplain AuthenticationAPIClient#loginWithNativeSocialToken(String, String)}
* instead.
*/
@NonNull
@Deprecated
public AuthRequest loginWithOAuthAccessToken(@NonNull String token, @NonNull String connection) {
HttpUrl url = HttpUrl.parse(auth0.getDomainUrl()).newBuilder()
.addPathSegment(OAUTH_PATH)
Expand Down Expand Up @@ -839,8 +846,11 @@ public ParameterizableRequest<Credentials, AuthenticationException> renewAuth(@N
*
* @param idToken issued by Auth0 for the user. The token must not be expired.
* @return a request to configure and start
* @deprecated The {@code /delegation} endpoint of the Auth0 Authorization API has been deprecated.
* This method will be removed in version 2 of this SDK.
*/
@NonNull
@Deprecated
public DelegationRequest<Delegation> delegationWithIdToken(@NonNull String idToken) {
ParameterizableRequest<Delegation, AuthenticationException> request = delegation(Delegation.class)
.addParameter(ParameterBuilder.ID_TOKEN_KEY, idToken);
Expand Down Expand Up @@ -868,8 +878,11 @@ public DelegationRequest<Delegation> delegationWithIdToken(@NonNull String idTok
*
* @param refreshToken issued by Auth0 for the user when using the 'offline_access' scope when logging in.
* @return a request to configure and start
* @deprecated The {@code /delegation} endpoint of the Auth0 Authorization API has been deprecated.
* This method will be removed in version 2 of this SDK.
*/
@NonNull
@Deprecated
public DelegationRequest<Delegation> delegationWithRefreshToken(@NonNull String refreshToken) {
ParameterizableRequest<Delegation, AuthenticationException> request = delegation(Delegation.class)
.addParameter(ParameterBuilder.REFRESH_TOKEN_KEY, refreshToken);
Expand Down Expand Up @@ -897,8 +910,11 @@ public DelegationRequest<Delegation> delegationWithRefreshToken(@NonNull String
* @param idToken issued by Auth0 for the user. The token must not be expired.
* @param apiType the delegation 'api_type' parameter
* @return a request to configure and start
* @deprecated The {@code /delegation} endpoint of the Auth0 Authorization API has been deprecated.
* This method will be removed in version 2 of this SDK.
*/
@NonNull
@Deprecated
public DelegationRequest<Map<String, Object>> delegationWithIdToken(@NonNull String idToken, @NonNull String apiType) {
ParameterizableRequest<Map<String, Object>, AuthenticationException> request = delegation()
.addParameter(ParameterBuilder.ID_TOKEN_KEY, idToken);
Expand Down Expand Up @@ -1052,8 +1068,11 @@ public ParameterizableRequest<Void, AuthenticationException> passwordlessWithSMS
* </pre>
*
* @return a request to configure and start
* @deprecated The {@code /delegation} endpoint of the Auth0 Authorization API has been deprecated.
* This method will be removed in version 2 of this SDK.
*/
@NonNull
@Deprecated
public ParameterizableRequest<Map<String, Object>, AuthenticationException> delegation() {
HttpUrl url = HttpUrl.parse(auth0.getDomainUrl()).newBuilder()
.addPathSegment(DELEGATION_PATH)
Expand Down
34 changes: 34 additions & 0 deletions auth0/src/main/java/com/auth0/android/authentication/ParameterBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,14 @@ public class ParameterBuilder {
public static final String GRANT_TYPE_REFRESH_TOKEN = "refresh_token";
public static final String GRANT_TYPE_PASSWORD = "password";
public static final String GRANT_TYPE_PASSWORD_REALM = "http://auth0.com/oauth/grant-type/password-realm";

/**
* @deprecated The {@code urn:ietf:params:oauth:grant-type:jwt-bearer} grant type is for use with legacy Authentication
* APIs. This constant will be removed in version 2 of this SDK.
*/
@Deprecated
public static final String GRANT_TYPE_JWT = "urn:ietf:params:oauth:grant-type:jwt-bearer";

public static final String GRANT_TYPE_AUTHORIZATION_CODE = "authorization_code";
public static final String GRANT_TYPE_MFA_OTP = "http://auth0.com/oauth/grant-type/mfa-otp";
public static final String GRANT_TYPE_PASSWORDLESS_OTP = "http://auth0.com/oauth/grant-type/passwordless/otp";
Expand All @@ -63,15 +70,33 @@ public class ParameterBuilder {
public static final String SCOPE_OPENID = "openid";
public static final String SCOPE_OFFLINE_ACCESS = "openid offline_access";

/**
* @deprecated The {@code id_token} parameter is only used when making requests to the legacy
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd link to https://auth0.com/docs/api/authentication#database-ad-ldap-active- as you did in others.

Also, DEVICE constant is still here. Should go away with ID token, same reason

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pushed a new commit to add the link and also deprecate the DEVICE constant

* <a href="https://auth0.com/docs/api/authentication#database-ad-ldap-active-">/oauth/ro</a> endpoint.
* This constant will be removed in version 2 of this SDK.
*/
@Deprecated
public static final String ID_TOKEN_KEY = "id_token";
public static final String SCOPE_KEY = "scope";
public static final String REFRESH_TOKEN_KEY = "refresh_token";
public static final String CONNECTION_KEY = "connection";
public static final String REALM_KEY = "realm";

/**
* @deprecated The {@code access_token} parameter is only used when making requests to the legacy
* Authentication APIs. This constant will be removed in version 2 of this SDK.
*/
@Deprecated
public static final String ACCESS_TOKEN_KEY = "access_token";
public static final String SEND_KEY = "send";
public static final String CLIENT_ID_KEY = "client_id";
public static final String GRANT_TYPE_KEY = "grant_type";

/**
* @deprecated The {@code device} parameter is only used when making requests to the legacy
* Authentication APIs. This constant will be removed in version 2 of this SDK.
*/
@Deprecated
public static final String DEVICE_KEY = "device";
public static final String AUDIENCE_KEY = "audience";

Expand Down Expand Up @@ -153,8 +178,12 @@ public ParameterBuilder setAudience(@NonNull String audience) {
*
* @param device a device name
* @return itself
*
* @deprecated The {@code device} parameter is used in calls to the <a href="https://auth0.com/docs/api/authentication#database-ad-ldap-active-">/oauth/ro</a>
* Authentication API legacy endpoint. This method will be removed in version 2 of this SDK.
*/
@NonNull
@Deprecated
public ParameterBuilder setDevice(@NonNull String device) {
return set(DEVICE_KEY, device);
}
Expand All @@ -164,8 +193,13 @@ public ParameterBuilder setDevice(@NonNull String device) {
*
* @param accessToken a access token
* @return itself
*
* @deprecated This method sets the token on the request made to the <a href="https://auth0.com/docs/api/authentication#social-with-provider-s-access-token">/oauth/access_token</a>
* Authentication API legacy endpoint, disabled as of June 2017. This method will be removed in
* version 2 of this SDK
*/
@NonNull
@Deprecated
public ParameterBuilder setAccessToken(@NonNull String accessToken) {
return set(ACCESS_TOKEN_KEY, accessToken);
}
Expand Down
3 changes: 3 additions & 0 deletions auth0/src/main/java/com/auth0/android/authentication/request/DelegationRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,10 @@
* @param <T> type of object that will hold the delegation response. When requesting Auth0's 'id_token' you can
* use {@link Delegation}, otherwise you'll need to provide an object that can be created from the JSON
* payload or just use {@code Map<String, Object>}
* @deprecated The {@code /delegation} endpoint has been deprecated. This class and any methods that
* make use of the {@code /delegation} endpoint will be removed in version 2 of this SDK.
*/
@Deprecated
public class DelegationRequest<T> implements Request<T, AuthenticationException> {

private static final String API_TYPE_KEY = "api_type";
Expand Down
1 change: 1 addition & 0 deletions auth0/src/main/java/com/auth0/android/authentication/request/SignUpRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ public SignUpRequest setAudience(@NonNull String audience) {

@NonNull
@Override
@Deprecated
public SignUpRequest setAccessToken(@NonNull String accessToken) {
getAuthRequest().setAccessToken(accessToken);
return this;
Expand Down
5 changes: 5 additions & 0 deletions auth0/src/main/java/com/auth0/android/request/AuthenticationRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,13 @@ public interface AuthenticationRequest extends Request<Credentials, Authenticati
*
* @param accessToken a access token
* @return itself
*
* @deprecated This method sets the token on the request made to the <a href="https://auth0.com/docs/api/authentication#social-with-provider-s-access-token">/oauth/access_token</a>
* Authentication API legacy endpoint, disabled as of June 2017. This method will be removed in
* version 2 of this SDK
*/
@NonNull
@Deprecated
AuthenticationRequest setAccessToken(@NonNull String accessToken);

/**
Expand Down
5 changes: 5 additions & 0 deletions auth0/src/main/java/com/auth0/android/request/internal/BaseAuthenticationRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,13 @@ public AuthRequest setAudience(@NonNull String audience) {
*
* @param accessToken a access token
* @return itself
*
* @deprecated This method sets the token on the request made to the <a href="https://auth0.com/docs/api/authentication#social-with-provider-s-access-token">/oauth/access_token</a>
* Authentication API legacy endpoint, disabled as of June 2017. This method will be removed in
* version 2 of this SDK
*/
@NonNull
@Deprecated
public AuthRequest setAccessToken(@NonNull String accessToken) {
addParameter(ACCESS_TOKEN_KEY, accessToken);
return this;
Expand Down
3 changes: 3 additions & 0 deletions auth0/src/main/java/com/auth0/android/result/Delegation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@
/**
* The result of a successful delegation to an Auth0 application that contains a new Auth0 'id_token'
* See <a href="https://auth0.com/docs/api/authentication#delegation">delegation</a> docs
* @deprecated The {@code /delegation} endpoint has been deprecated. This class and any methods that
* make use of the {@code /delegation} endpoint will be removed in version 2 of this SDK.
*/
@Deprecated
public class Delegation {
@SerializedName("id_token")
private final String idToken;
Expand Down