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.

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

Docs: Authentication Entity Updates For .NET #491

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

dericksozo
Copy link
Contributor

(docs): Making changes to the Authentication Entity documentation page to account for the differences between .NET and Node.js authentication implementations.

This PR takes care of #489.

…age to account for the differences between .NET and Node.js authentication implementations.
@dericksozo dericksozo added the documentation Improvements or additions to documentation label Jun 27, 2024
@dericksozo dericksozo self-assigned this Jun 27, 2024
@@ -20,7 +20,7 @@ However, you can choose to use your own custom Authentication entity as long as

## Dependencies Between the Authentication Entity and Authentication Plugins

The authentication plugins, such as the _NestJS Auth Module_ and others, rely on the existence of an _Authentication_ entity to handle user authentication and authorization.
The authentication plugins rely on the existence of an _Authentication_ entity to handle user authentication and authorization. For Node.js services, this includes the _NestJS Auth Module_ and others. For .NET services, this includes the _ASP.NET Core Identity_ plugin.
Copy link
Member

Choose a reason for hiding this comment

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

I think it should be "For Node.js services, this includes the NestJS Auth Module or others".
I.e. "or" instead of "and". Is that correct- English-wise?

@@ -32,15 +32,15 @@ An Authentication plugin requires an Authentication entity containing the proper

By default, the 'User' entity is defined as the Authentication entity, but you can [configure it](#changing-the-default-authentication-entity). If the `User` entity is created automatically, it comes with a set of default fields necessary for the authentication plugins to work correctly:

- `id` (required by all authentication plugins): An automatically created unique identifier of the entity. It is a required and unique field.
Copy link
Member

Choose a reason for hiding this comment

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

@mulygottlieb - Can you please review the list and whether the "required" fields are indeed required for all the auth plugins (.NET and Node.js)?

@PazYanoverr
Copy link
Member

@mulygottlieb - As discussed, and since the .NET auth behavior is different from the Node.js one- please share a doc with us that describes the auth behavior on .NET. Thanks!
@dericksozo - FYI

@dericksozo
Copy link
Contributor Author

Thanks, @PazYanoverr @mulygottlieb. I'll keep posted for any additional materials.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants