OAuth 2.0 overview in Rest API

Introduction

OAuth 2.0 helps apps safely access your information without sharing your password. It lets you give limited access to your data on other websites or apps.

When you want to let a website post on your social media without giving it your password.

When an app needs to read your email or calendar but you don't want to share your login details.

When you want to sign into a new app using your Google or Facebook account.

When a service needs to access your data on another service securely and temporarily.

Syntax

Rest API

OAuth 2.0 uses these main steps:
1. Client requests permission from user.
2. User grants permission and gets an authorization code.
3. Client exchanges code for an access token.
4. Client uses access token to access protected resources.
5. Access token expires or is revoked.

The access token is like a temporary key to your data.

The authorization code is a short-lived code to get the access token.

Examples

This is the URL where the user is asked to approve access.

Rest API

GET /authorize?response_type=code&client_id=abc123&redirect_uri=https://app.com/callback&scope=read_profile

The client sends this request to exchange the authorization code for an access token.

Rest API

POST /token
Headers: Content-Type: application/x-www-form-urlencoded
Body: grant_type=authorization_code&code=AUTH_CODE&redirect_uri=https://app.com/callback&client_id=abc123&client_secret=secret

The client uses the access token to get user data.

Rest API

GET /user/profile
Headers: Authorization: Bearer ACCESS_TOKEN

Sample Program

This example shows the main OAuth 2.0 steps: getting authorization, exchanging code for token, and using the token to access data.

Rest API

import requests

# Step 1: User is redirected to this URL to authorize
auth_url = (
    "https://example.com/oauth/authorize?"
    "response_type=code&client_id=abc123&redirect_uri=https://app.com/callback&scope=read"
)
print(f"Go to this URL and authorize: {auth_url}")

# Step 2: After user authorizes, they get a code (simulate here)
authorization_code = "sample_auth_code"

# Step 3: Exchange code for access token
response = requests.post(
    "https://example.com/oauth/token",
    data={
        "grant_type": "authorization_code",
        "code": authorization_code,
        "redirect_uri": "https://app.com/callback",
        "client_id": "abc123",
        "client_secret": "secret"
    }
)

# Simulate response
response_json = {"access_token": "sample_access_token", "token_type": "Bearer", "expires_in": 3600}

print(f"Access token received: {response_json['access_token']}")

# Step 4: Use access token to get user info
headers = {"Authorization": f"Bearer {response_json['access_token']}"}
# Simulate user info request
user_info = {"id": "user123", "name": "Alice"}
print(f"User info: {user_info}")

Important Notes

OAuth 2.0 does not share your password with the app requesting access.

Access tokens usually expire after some time for security.

Always keep your client secret safe and never share it publicly.

Summary

OAuth 2.0 lets apps access your data safely without your password.

It uses authorization codes and access tokens to control access.

This keeps your information secure and under your control.

Practice

1. What is the main purpose of OAuth 2.0 in REST APIs?

easy

A. To replace usernames with email addresses

B. To encrypt all data sent between client and server

C. To allow apps to access user data securely without sharing passwords

D. To speed up API response times

Solution

1. Step 1: Understand OAuth 2.0's role

   OAuth 2.0 is designed to let apps access user data safely without needing the user's password.

2. Step 2: Compare options to OAuth 2.0 purpose

   Only To allow apps to access user data securely without sharing passwords correctly describes this purpose. Options A, B, and D describe unrelated functions.

3. Final Answer:

   To allow apps to access user data securely without sharing passwords -> Option C

4. Quick Check:

   OAuth 2.0 = Secure data access without password sharing [OK]

Hint: OAuth 2.0 = safe access without password sharing [OK]

Common Mistakes:

• Confusing OAuth with encryption protocols
• Thinking OAuth replaces usernames
• Assuming OAuth speeds up APIs

2. Which of the following is the correct OAuth 2.0 flow step to get an access token?

easy

A. Client sends password directly to resource server

B. Client sends authorization code to the authorization server

C. Resource server sends access token to client without request

D. Client sends refresh token to user

Solution

1. Step 1: Identify OAuth 2.0 token exchange step

   The client sends the authorization code to the authorization server to exchange it for an access token.

2. Step 2: Eliminate incorrect options

   Client sends password directly to resource server is wrong because passwords are not sent directly. Resource server sends access token to client without request is wrong because tokens are sent after request. Client sends refresh token to user is wrong because refresh tokens are sent to the authorization server, not the user.

3. Final Answer:

   Client sends authorization code to the authorization server -> Option B

4. Quick Check:

   Authorization code sent to server = Step to get access token [OK]

Hint: Authorization code sent to server to get token [OK]

Common Mistakes:

• Sending password instead of authorization code
• Expecting tokens without request
• Confusing refresh token recipient

3. Given this OAuth 2.0 flow snippet:

1. Client requests authorization code
2. User grants permission
3. Client receives authorization code
4. Client sends authorization code to token endpoint
5. Token endpoint returns access token

What is the output after step 5?

medium

A. Client has an access token to access protected resources

B. Client has the user's password

C. Client can directly access user data without token

D. Client must request authorization code again

Solution

1. Step 1: Follow OAuth 2.0 flow steps

   After step 5, the client receives an access token from the token endpoint.

2. Step 2: Understand access token purpose

   The access token lets the client access protected user data securely without needing the password.

3. Final Answer:

   Client has an access token to access protected resources -> Option A

4. Quick Check:

   Access token received = Access to resources [OK]

Hint: Access token means access granted to resources [OK]

Common Mistakes:

• Thinking client gets user password
• Assuming token is not needed for access
• Believing authorization code must be requested again

4. Identify the error in this OAuth 2.0 flow:

Client sends access token directly to user
User sends authorization code to resource server

medium

A. Access token should be sent to resource server, not user

B. Authorization code should be sent to client, not user

C. Client should never send tokens at all

D. User should send access token to authorization server

Solution

1. Step 1: Analyze token flow roles

   Access tokens are meant for the resource server to verify access, not for the user.

2. Step 2: Check authorization code flow

   The authorization code is sent from user to client, not to the resource server.

3. Final Answer:

   Access token should be sent to resource server, not user -> Option A

4. Quick Check:

   Access token destination = Resource server [OK]

Hint: Access token goes to resource server, not user [OK]

Common Mistakes:

• Sending access token to user instead of server
• Confusing authorization code recipient
• Thinking client never sends tokens

5. You want to build an app that accesses user data from a REST API using OAuth 2.0. Which combination correctly describes the roles and tokens involved?

hard

A. Client app sends refresh token to user to renew access token

B. User sends access token to client app, which then sends password to resource server

C. Resource server issues authorization code directly to client app without user consent

D. Client app uses authorization code to get access token from authorization server, then uses access token to access resource server

Solution

1. Step 1: Understand OAuth 2.0 roles

   The client app requests an authorization code from the authorization server after user consent.

2. Step 2: Token exchange and usage

   The client exchanges the authorization code for an access token, then uses it to access the resource server.

3. Final Answer:

   Client app uses authorization code to get access token from authorization server, then uses access token to access resource server -> Option D

4. Quick Check:

   Authorization code -> access token -> resource access [OK]

Hint: Authorization code to token, then token to resource [OK]

Common Mistakes:

• Thinking user sends tokens to client
• Assuming resource server issues codes without user
• Confusing refresh token flow