Skip to content

Commit

Permalink
Merge pull request #839 from kenjis/docs-reorganize
Browse files Browse the repository at this point in the history
docs: reorganize (part 1)
  • Loading branch information
kenjis authored Sep 19, 2023
2 parents 424b2cb + 8115054 commit fdd5bcb
Show file tree
Hide file tree
Showing 25 changed files with 661 additions and 791 deletions.
4 changes: 0 additions & 4 deletions docs/auth_actions.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# Authentication Actions

- [Authentication Actions](#authentication-actions)
- [Configuring Actions](#configuring-actions)
- [Defining New Actions](#defining-new-actions)

Authentication Actions are a way to group actions that can happen after login or registration.
Shield ships with two actions you can use, and makes it simple for you to define your own.

Expand Down
28 changes: 0 additions & 28 deletions docs/authentication.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,5 @@
# Authentication

- [Authentication](#authentication)
- [Available Authenticators](#available-authenticators)
- [Auth Helper](#auth-helper)
- [Authenticator Responses](#authenticator-responses)
- [isOK()](#isok)
- [reason()](#reason)
- [extraInfo()](#extrainfo)
- [Session Authenticator](#session-authenticator)
- [attempt()](#attempt)
- [check()](#check)
- [loggedIn()](#loggedin)
- [logout()](#logout)
- [forget()](#forget)
- [Access Token Authenticator](#access-token-authenticator)
- [Access Token/API Authentication](#access-tokenapi-authentication)
- [Generating Access Tokens](#generating-access-tokens)
- [Revoking Access Tokens](#revoking-access-tokens)
- [Retrieving Access Tokens](#retrieving-access-tokens)
- [Access Token Lifetime](#access-token-lifetime)
- [Access Token Scopes](#access-token-scopes)
- [HMAC SHA256 Token Authenticator](#hmac-sha256-token-authenticator)
- [HMAC Keys/API Authentication](#hmac-keysapi-authentication)
- [Generating HMAC Access Keys](#generating-hmac-access-keys)
- [Revoking HMAC Keys](#revoking-hmac-keys)
- [Retrieving HMAC Keys](#retrieving-hmac-keys)
- [HMAC Keys Lifetime](#hmac-keys-lifetime)
- [HMAC Keys Scopes](#hmac-keys-scopes)

Authentication is the process of determining that a visitor actually belongs to your website,
and identifying them. Shield provides a flexible and secure authentication system for your
web apps and APIs.
Expand Down
25 changes: 0 additions & 25 deletions docs/authorization.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,5 @@
# Authorization

- [Authorization](#authorization)
- [Defining Available Groups](#defining-available-groups)
- [Default User Group](#default-user-group)
- [Defining Available Permissions](#defining-available-permissions)
- [Assigning Permissions to Groups](#assigning-permissions-to-groups)
- [Authorizing Users](#authorizing-users)
- [can()](#can)
- [inGroup()](#ingroup)
- [hasPermission()](#haspermission)
- [Authorizing via Routes](#authorizing-via-routes)
- [Managing User Permissions](#managing-user-permissions)
- [addPermission()](#addpermission)
- [removePermission()](#removepermission)
- [syncPermissions()](#syncpermissions)
- [getPermissions()](#getpermissions)
- [Managing User Groups](#managing-user-groups)
- [addGroup()](#addgroup)
- [removeGroup()](#removegroup)
- [syncGroups()](#syncgroups)
- [getGroups()](#getgroups)
- [User Activation](#user-activation)
- [Checking Activation Status](#checking-activation-status)
- [Activating a User](#activating-a-user)
- [Deactivating a User](#deactivating-a-user)

Authorization happens once a user has been identified through authentication. It is the process of
determining what actions a user is allowed to do within your site.

Expand Down
9 changes: 1 addition & 8 deletions docs/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,6 @@

This document covers some of the base concepts used throughout the library.

- [Shield Concepts](#shield-concepts)
- [Repository State](#repository-state)
- [Settings](#settings)
- [User Providers](#user-providers)
- [User Identities](#user-identities)
- [Password Validators](#password-validators)

## Repository State

Shield is designed so that the initial setup of your application can all happen in code with nothing required to be
Expand All @@ -28,7 +21,7 @@ on the standard Config class if nothing is found in the database.
Shield has a model to handle user persistence. Shield calls this the "User Provider" class.
A default model is provided for you by the `CodeIgniter\Shield\Models\UserModel` class.

You can use your own model to customize user attributes. See [Customizing Shield](./customization.md#custom-user-provider) for details.
You can use your own model to customize user attributes. See [Customizing User Provider](./customization/user_provider.md) for details.

## User Identities

Expand Down
Loading

0 comments on commit fdd5bcb

Please sign in to comment.