Skip to content

Conversation

555vedant
Copy link
Contributor

this pull request outlines OIDC and OAuth 2.0 doc implementation in uPortal. It covers OIDC endpoints, group and claims filters, and OAuth endpoint usage for clients, aiding developers in secure user authentication and profile information retrieval.

Key features:

1)Detailed descriptions and examples of OIDC endpoints.

2)Configuration for group and claims filters.

3)Client registration and scope definitions.

4)Security considerations for token management.

References:

1)Official OIDC and OAuth 2.0 specifications.

2)uPortal documentation links.

@555vedant
Copy link
Contributor Author

555vedant commented Oct 16, 2024

@ChristianMurphy @jonathanmtran sir please once review this PR and pls suggest changes if there ?

Copy link
Contributor

@jonathanmtran jonathanmtran left a comment

Choose a reason for hiding this comment

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

There is documentation for endpoints that do not exist in uPortal ...

Did you actually test the endpoints to see if uPortal responds as expected?

- **HTTP Method**: `GET`
- **Example Request**:
```
GET /uPortal/api/v5-1/oauth/authorize?response_type=code&client_id={client_id}&redirect_uri={redirect_uri}&scope=openid&state={state}&claims={custom_claims}
Copy link
Contributor

Choose a reason for hiding this comment

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

This endpoint does not exist

- **HTTP Method**: `POST`
- **Example Request**:
```
POST /uPortal/api/v5-1/oauth/token
Copy link
Contributor

Choose a reason for hiding this comment

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

This endpoint does not exist

- **HTTP Method**: `GET`
- **Example Request**:
```
GET /uPortal/api/v5-1/oauth/logout?post_logout_redirect_uri={redirect_uri}&id_token_hint={id_token}
Copy link
Contributor

Choose a reason for hiding this comment

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

This endpoint does not exist


**Example Request**:
```
GET /uPortal/api/v5-1/oauth/authorize?response_type=code&client_id={client_id}&redirect_uri={redirect_uri}&scope=openid&claims={"userinfo":{"user_id":{"essential":true},"roles":{"values":["student","faculty"]}}}
Copy link
Contributor

Choose a reason for hiding this comment

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

This endpoint does not exist


**Example Request**:
```
POST /uPortal/api/v5-1/oauth/token
Copy link
Contributor

Choose a reason for hiding this comment

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

This endpoint does not exist


**Example Request**:
```
GET /uPortal/api/v5-1/oauth/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 endpoint does not exist

- **HTTP Method**: `GET`
- **Example Request**:
```
GET /uPortal/api/v5-1/oauth/userinfo
Copy link
Contributor

Choose a reason for hiding this comment

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

The path is incorrect

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The path is incorrect

what is correct path ??

@555vedant
Copy link
Contributor Author

@jonathanmtran sir please can you provide me some resources from whom i can make endpoints and path correctly ??

@ChristianMurphy
Copy link
Member

sir please can you provide me some resources from whom i can make endpoints and path correctly ??

@555vedant The actual API provide swagger docs, follow @jonathanmtran's recommendation here
#2860 (comment) to spin up uPortal-start

The swagger API can be switched on with https://uportal-project.github.io/uPortal/developer/other/API.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants