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

Deprecate Authentication API endpoints #121

Merged
merged 2 commits into from
Jul 23, 2018
Merged

Deprecate Authentication API endpoints #121

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f015b4b
Add deprecation notices
joshcanhelp Jul 20, 2018
040f17e
PR feedback
joshcanhelp Jul 23, 2018
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
176 changes: 91 additions & 85 deletions lib/auth0/api/authentication_endpoints.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,93 @@ def start_passwordless_sms_flow(phone_number)
post('/passwordless/start', request_params)
end

# Retrive SAML 2.0 metadata XMLfor an Application.
Copy link
Contributor

Choose a reason for hiding this comment

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

typos retrieve and xmlfor

# @see https://auth0.com/docs/api/authentication#get-metadata
# @return [xml] SAML 2.0 metadata
def saml_metadata
get("/samlp/metadata/#{@client_id}")
end

# Retrieve WS-Federation metadata XML for a tenant.
# @see https://auth0.com/docs/api/authentication#get-metadata36
# @return [xml] WS-Federation metadata
def wsfed_metadata
get('/wsfed/FederationMetadata/2007-06/FederationMetadata.xml')
end

# Return the user information based on the Auth0 access token.
# @see https://auth0.com/docs/api/authentication#get-user-info
# @return [json] User information based on the Auth0 access token
def user_info
get('/userinfo')
Copy link
Contributor

Choose a reason for hiding this comment

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

this call requires an access_token. How is the user able to pass it? Please add a sample here below my comment, as the tokeninfo method looks different. Also would be nice to validate the presence like here

raise Auth0::InvalidParameter, 'Must supply a valid access_token' if access_token.to_s.empty?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Method was not changed from the original. Will be replacing in another PR/task and deprecating this one. Not added, just moved.

end

# Return an authorization URL.
# @see https://auth0.com/docs/api/authentication#authorization-code-grant
# @param redirect_uri [string] URL to redirect after authorization
# @param options [hash] Can contain response_type, connection, state and additional_parameters.
# @return [url] Authorization URL.
def authorization_url(redirect_uri, options = {})
raise Auth0::InvalidParameter, 'Must supply a valid redirect_uri' if redirect_uri.to_s.empty?
request_params = {
client_id: @client_id,
response_type: options.fetch(:response_type, 'code'),
connection: options.fetch(:connection, nil),
redirect_uri: redirect_uri,
state: options.fetch(:state, nil),
Copy link
Contributor

Choose a reason for hiding this comment

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

It seems I'm not able to pass a nonce value on this call. If true, please track this issue as needs to be solved.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Method was not changed from the original. Will be replacing in another PR/task and deprecating this one. Not added, just moved.

scope: options.fetch(:scope, nil)
}.merge(options.fetch(:additional_parameters, {}))

URI::HTTPS.build(host: @domain, path: '/authorize', query: to_query(request_params))
end

# Returns an Auth0 logout URL with a return URL.
# @see https://auth0.com/docs/api/authentication#logout
# @see https://auth0.com/docs/logout
# @param return_to [string] URL to redirect after logout.
# @param include_client [bool] Include the client_id in the logout URL.
# @param federated [boolean] Perform a federated logout.
# @return [url] Logout URI
def logout_url(return_to, include_client: false, federated: false)
request_params = {
returnTo: return_to,
client_id: include_client ? @client_id : nil,
federated: federated ? '1' : nil
}

URI::HTTPS.build(
host: @domain,
path: '/v2/logout',
query: to_query(request_params)
)
end

# Return a SAMLP URL.
# The SAML Request AssertionConsumerServiceURL will be used to POST back
# the assertion and it must match with the application callback URL.
# @see https://auth0.com/docs/api/authentication#accept-request
# @param connection [string] Connection to use; empty to show all
# @return [url] SAMLP URL
def samlp_url(connection = UP_AUTH)
request_params = {
connection: connection
}
URI::HTTPS.build(host: @domain, path: "/samlp/#{@client_id}", query: to_query(request_params))
end

# Return a WS-Federation URL.
# @see https://auth0.com/docs/api/authentication#accept-request35
# @param connection [string] Connection to use; empty to show all
# @return [url] WS-Federation URL
def wsfed_url(connection = UP_AUTH)
request_params = {
whr: connection
}
URI::HTTPS.build(host: @domain, path: "/wsfed/#{@client_id}", query: to_query(request_params))
end

# Login using phone number + verification code.
# @deprecated 4.5.0 - Legacy authentication pipeline; use a Password Grant instead
Copy link
Contributor

Choose a reason for hiding this comment

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

You can link to https://auth0.com/docs/applications/application-grant-types or even https://auth0.com/docs/api-auth/tutorials/password-grant

# @see https://auth0.com/docs/api/authentication#resource-owner
# @param phone_number [string] User's phone number.
# @param code [string] Verification code.
Expand All @@ -157,21 +243,8 @@ def phone_login(phone_number, code, scope = 'openid')
post('/oauth/ro', request_params)
end

# Retrive SAML 2.0 metadata XMLfor an Application.
# @see https://auth0.com/docs/api/authentication#get-metadata
# @return [xml] SAML 2.0 metadata
def saml_metadata
get("/samlp/metadata/#{@client_id}")
end

# Retrieve WS-Federation metadata XML for a tenant.
# @see https://auth0.com/docs/api/authentication#get-metadata36
# @return [xml] WS-Federation metadata
def wsfed_metadata
get('/wsfed/FederationMetadata/2007-06/FederationMetadata.xml')
end

# Validate a JSON Web Token (signature and expiration).
# @deprecated 4.5.0 - legacy endpoint, use /userinfo instead.
# @see https://auth0.com/docs/api/authentication#get-token-info
# @param id_token [string] ID Token to use
# @return User information associated with the user id (sub property) of the token.
Expand All @@ -182,6 +255,7 @@ def token_info(id_token)
end

# Refresh a delegation token.
# @deprecated 4.5.0 - feature is disabled, no replacement currently.
Copy link
Contributor

Choose a reason for hiding this comment

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

can link to https://auth0.com/docs/api-auth/tutorials/adoption/delegation

# @see https://auth0.com/docs/api/authentication#delegation
# @param refresh_token [string] Token to refresh
# @param target [string] Target to sign the new token.
Expand All @@ -204,6 +278,7 @@ def refresh_delegation(refresh_token, target, scope = 'openid', api_type = 'app'
end

# Retrieve a delegation token.
# @deprecated 4.5.0 - feature is disabled, no replacement currently.
Copy link
Contributor

Choose a reason for hiding this comment

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

can link to https://auth0.com/docs/api-auth/tutorials/adoption/delegation

# @see https://auth0.com/docs/api/authentication#delegation
# @param id_token [string] Token's id.
# @param target [string] Target to sign the new token.
Expand All @@ -226,6 +301,7 @@ def delegation(id_token, target, scope = 'openid', api_type = 'app', extra_param
end

# Retrieve an impersonation URL to login as another user.
# @deprecated 4.5.0 - feature is disabled.
# @see https://auth0.com/docs/api/authentication#impersonation
# @param user_id [string] Impersonate user id
# @param app_client_id [string] Application client id
Expand Down Expand Up @@ -257,6 +333,7 @@ def impersonate(user_id, app_client_id, impersonator_id, options)
# rubocop:enable Metrics/MethodLength, Metrics/AbcSize

# Unlink a user's account from the identity provider.
# @deprecated 4.5.0 - endpoint is disabled, use the Management API instead.
Copy link
Contributor

Choose a reason for hiding this comment

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

can link to https://auth0.com/docs/migrations/guides/account-linking

# @see https://auth0.com/docs/api/authentication#unlink
# @param access_token [string] Logged-in user access token
# @param user_id [string] User Id
Expand All @@ -270,77 +347,6 @@ def unlink_user(access_token, user_id)
post('/unlink', request_params)
end

# Return the user information based on the Auth0 access token.
# @see https://auth0.com/docs/api/authentication#get-user-info
# @return [json] User information based on the Auth0 access token
def user_info
get('/userinfo')
end

# Return an authorization URL.
# @see https://auth0.com/docs/api/authentication#authorization-code-grant
# @param redirect_uri [string] URL to redirect after authorization
# @param options [hash] Can contain response_type, connection, state and additional_parameters.
# @return [url] Authorization URL.
def authorization_url(redirect_uri, options = {})
raise Auth0::InvalidParameter, 'Must supply a valid redirect_uri' if redirect_uri.to_s.empty?
request_params = {
client_id: @client_id,
response_type: options.fetch(:response_type, 'code'),
connection: options.fetch(:connection, nil),
redirect_uri: redirect_uri,
state: options.fetch(:state, nil),
scope: options.fetch(:scope, nil)
}.merge(options.fetch(:additional_parameters, {}))

URI::HTTPS.build(host: @domain, path: '/authorize', query: to_query(request_params))
end

# Returns an Auth0 logout URL with a return URL.
# @see https://auth0.com/docs/api/authentication#logout
# @see https://auth0.com/docs/logout
# @param return_to [string] URL to redirect after logout.
# @param include_client [bool] Include the client_id in the logout URL.
# @param federated [boolean] Perform a federated logout.
# @return [url] Logout URI
def logout_url(return_to, include_client: false, federated: false)
request_params = {
returnTo: return_to,
client_id: include_client ? @client_id : nil,
federated: federated ? '1' : nil
}

URI::HTTPS.build(
host: @domain,
path: '/v2/logout',
query: to_query(request_params)
)
end

# Return a SAMLP URL.
# The SAML Request AssertionConsumerServiceURL will be used to POST back
# the assertion and it must match with the application callback URL.
# @see https://auth0.com/docs/api/authentication#accept-request
# @param connection [string] Connection to use; empty to show all
# @return [url] SAMLP URL
def samlp_url(connection = UP_AUTH)
request_params = {
connection: connection
}
URI::HTTPS.build(host: @domain, path: "/samlp/#{@client_id}", query: to_query(request_params))
end

# Return a WS-Federation URL.
# @see https://auth0.com/docs/api/authentication#accept-request35
# @param connection [string] Connection to use; empty to show all
# @return [url] WS-Federation URL
def wsfed_url(connection = UP_AUTH)
request_params = {
whr: connection
}
URI::HTTPS.build(host: @domain, path: "/wsfed/#{@client_id}", query: to_query(request_params))
end

private

# Build a URL query string from a hash.
Expand Down