Skip to content

Commit d35f931

Browse files
author
Dan Costello
committed
Reference link updates
1 parent aa1e135 commit d35f931

7 files changed

Lines changed: 9 additions & 8 deletions

File tree

content/docs/reference/(API-fundamentals)/2-authorization-code-flow.mdx renamed to content/docs/reference/(API-fundamentals)/authorization-code-flow.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ hidden: false
66
createdAt: "Thu Aug 10 2023 20:34:09 GMT+0000 (Coordinated Universal Time)"
77
updatedAt: "Thu Aug 10 2023 20:39:14 GMT+0000 (Coordinated Universal Time)"
88
---
9-
## Overview
10-
119
The Authorization Code Flow is the most commonly used and recommended OAuth 2.0 authentication flow for server-side and web applications. It provides a secure method for obtaining access tokens by exchanging an authorization code obtained through a user's interaction with an authorization server.
1210

1311
If the application can be trusted to hold a secret (like a web application with secure backend), the standard Authorization Code flow can be used. If the application cannot securely hold a secret (like a web single-page app or mobile app), and particularly if access tokens are needed, it should utilize the Proof Key Code Exchange feature to prevent token hijacking.

content/docs/reference/(API-fundamentals)/5-client-credentials-flow.mdx renamed to content/docs/reference/(API-fundamentals)/client-credentials-flow.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ hidden: false
66
createdAt: "Thu Aug 10 2023 20:35:26 GMT+0000 (Coordinated Universal Time)"
77
updatedAt: "Thu Aug 10 2023 20:36:43 GMT+0000 (Coordinated Universal Time)"
88
---
9-
## Overview
10-
119
The Client Credentials Flow is an OAuth 2.0 authentication flow that enables a client application to obtain an access token directly from an authorization server by using its own client credentials (typically a client ID and client secret). This flow is suitable for machine-to-machine communication where the client application needs to access resources _without_ user involvement.
1210

1311
## Flow Description

content/docs/reference/(API-fundamentals)/1-connecting-to-the-api.mdx renamed to content/docs/reference/(API-fundamentals)/connecting-to-the-api.mdx

File renamed without changes.

content/docs/reference/(API-fundamentals)/3-hybrid-flow.mdx renamed to content/docs/reference/(API-fundamentals)/hybrid-flow.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ hidden: false
66
createdAt: "Thu Aug 10 2023 20:34:27 GMT+0000 (Coordinated Universal Time)"
77
updatedAt: "Thu Aug 10 2023 20:36:43 GMT+0000 (Coordinated Universal Time)"
88
---
9-
## Overview
10-
119
The Hybrid Flow is an extension of the OAuth 2.0 framework that combines elements of the Authorization Code Flow and the Implicit Flow. It is designed to support scenarios where a web application requires both immediate access to certain user information and the ability to securely exchange an authorization code for tokens on the backend.
1210

1311
## Flow Description

content/docs/reference/(API-fundamentals)/4-implicit-flow.mdx renamed to content/docs/reference/(API-fundamentals)/implicit-flow.mdx

File renamed without changes.
Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
11
{
2-
"title": "API Fundamentals"
2+
"title": "API Fundamentals",
3+
"pages": [
4+
"connecting-to-the-api",
5+
"authorization-code-flow",
6+
"hybrid-flow",
7+
"implicit-flow",
8+
"client-credentials-flow"
9+
]
310
}

content/docs/reference/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ title: "UserClouds API Reference"
55
import {redirect} from "next/navigation";
66

77
export default function Page() {
8-
redirect("/docs/reference/1-connecting-to-the-api");
8+
redirect("/docs/reference/connecting-to-the-api");
99
}

0 commit comments

Comments
 (0)