Summary

Add documentation for service accounts.

Review Request #15195 — Created July 24, 2026 and submitted July 31, 2026, 3:32 a.m.

Information

Owner

maubin

Repository

Review Board

Branch

release-8.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This adds documentation for how to use service accounts and the
service account hook, with an example.

Testing Done

Built the docs and viewed.

Commits

Summary	ID
Add documentation for service accounts. This adds documentation for how to use service accounts and the service account hook, with an example.	3cd742cc92e1cbc41f45fbb61175933daec5e226

Issues

Description	From	Last Updated
grammar: represent -> represents	david	July 27, 2026, 2:24 a.m.
Seems like this got reworded, and it now says "that you are to migrating over". How about "If you have …	david	July 27, 2026, 2:29 a.m.
This line looks slightly too long.	david	July 27, 2026, 2:30 a.m.
Just to demonstrate a good example, we should probably allow GET/HEAD/OPTIONS on the root as well.	david	July 27, 2026, 2:33 a.m.
Resource-specific policy entries need to be one level deeper (our existing docs are not great about that): { 'resources': { …	david	July 28, 2026, 6:05 a.m.
This can just be # here.	chipx86	July 31, 2026, 3:31 a.m.

flake8 passed.

JSHint passed.

docs/manual/extending/extensions/hooks/index.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
grammar: represent -> represents
```

docs/manual/extending/extensions/hooks/service-account-hook.rst (Diff revision 1)

The issue has been resolved. Show all issues

Seems like this got reworded, and it now says "that you are to migrating over".

How about "If you have an existing user account that you want to migrate to a service account, this should be set to its username"?

docs/manual/extending/extensions/hooks/service-account-hook.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
This line looks slightly too long.
```
docs/manual/extending/extensions/hooks/service-account-hook.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Just to demonstrate a good example, we should probably allow GET/HEAD/OPTIONS on the root as well.
```

Commits:

	Summary	ID
	Add documentation for service accounts. This adds documentation for how to use service accounts and the service account hook, with an example.	47b3b4589b16193c2df8414fd763cc59cd8c507f
	Add documentation for service accounts. This adds documentation for how to use service accounts and the service account hook, with an example.	e0f9b4f0509e7bc48ce469055c03a2413eff1096

Diff:

Revision 2 (+358 -2)

Show changes

	docs/manual/extending/extensions/hooks/index.rst
	docs/manual/extending/extensions/hooks/service-account-hook.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

docs/manual/extending/extensions/hooks/service-account-hook.rst (Diff revision 2)

The issue has been resolved. Show all issues

Resource-specific policy entries need to be one level deeper (our existing docs are not great about that):

{
    'resources': {
        '*': {
            'allow': ['GET', 'HEAD', 'OPTIONS'],
            'block': ['*'],
        },
        'review_request': {
            '*': {
                'allow': ['*'],
                'block': [],
            },
        },
        'review': {
            '*': {
                'allow': ['*'],
                'block': [],
            },
        },
    },
}

Change Summary:

Corrected the API policy and updated it to make more sense for the example.

Commits:

	Summary	ID
	Add documentation for service accounts. This adds documentation for how to use service accounts and the service account hook, with an example.	e0f9b4f0509e7bc48ce469055c03a2413eff1096
	Add documentation for service accounts. This adds documentation for how to use service accounts and the service account hook, with an example.	3cd742cc92e1cbc41f45fbb61175933daec5e226

Diff:

Revision 3 (+390 -2)

Show changes

	docs/manual/extending/extensions/hooks/index.rst
	docs/manual/extending/extensions/hooks/service-account-hook.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

docs/manual/extending/extensions/hooks/service-account-hook.rst (Diff revision 3)
The issue has been resolved. Show all issues
```
This can just be # here.
```

Status:: Completed
Change Summary:: Pushed to release-8.x (32d3fb7)