Skip to content
Goiabada
Search
Ctrl
K
Cancel
llms.txt
llms-full.txt
GitHub
Select theme
Dark
Light
Auto
Menu
Get started
Introduction
Quickstart
First sign-in
Guides
Add sign-in to a web app
Add sign-in to a SPA or mobile app
Sign users out
Protect an API
Require two-factor authentication
Single sign-on across clients
Let clients register themselves (DCR)
Customize and translate the pages
Concepts
Clients
Users and groups
Self-registration
Password recovery
Resources and permissions
Scopes
Tokens
Refresh tokens
Sessions
Ending sessions
ACR and AMR
prompt
id_token_hint
PKCE
Audit log
Glossary
Deploy
Choose a method
Setup wizard
Docker Compose
Cloudflare Tunnel
Cloudflare + Nginx
Reverse proxy
Kubernetes
Overview
Gateway and certificates
High availability
Security
Secrets
Probes and shutdown
Native binaries
Client IP and proxy trust
Database
Secrets
Rotate secrets
Upgrade Goiabada
Monitoring
Logs
Production checklist
Reference
Endpoints
Authorize
Token
Logout
UserInfo
Dynamic client registration
Discovery and JWKS
Logo and picture
API
Authentication
Scopes
Administrators
Errors
Admin API
Overview
Users
Overview
Search users
GET
Create user
POST
Get user
GET
Delete user
DELETE
Update user profile
PUT
Update user email
PUT
Generate email verification code
POST
Update user phone
PUT
Update user address
PUT
Update user password
PUT
Enable/disable user
PUT
Disable user OTP
PUT
Get user profile picture info
GET
Upload user profile picture
POST
Delete user profile picture
DELETE
Get user groups
GET
Set user groups
PUT
User Attributes
Overview
List user attributes
GET
Create user attribute
POST
Get user attribute
GET
Update user attribute
PUT
Delete user attribute
DELETE
User Sessions
Overview
List user sessions
GET
Get session
GET
Delete session
DELETE
User Consents
Overview
List user consents
GET
Revoke consent
DELETE
Groups
Overview
List groups
GET
Create group
POST
Search groups annotated with a permission
GET
Get group
GET
Update group
PUT
Delete group
DELETE
Group Members
Overview
List group members
GET
Add group member
POST
Remove group member
DELETE
Group Attributes
Overview
List group attributes
GET
Create group attribute
POST
Get group attribute
GET
Update group attribute
PUT
Delete group attribute
DELETE
Resources
Overview
List resources
GET
Create resource
POST
Get resource
GET
Update resource
PUT
Delete resource
DELETE
Get resource permissions
GET
Update resource permissions
PUT
Permissions
Overview
Get user permissions
GET
Set user permissions
PUT
Get group permissions
GET
Set group permissions
PUT
Get users with permission
GET
Clients
Overview
List clients
GET
Create client
POST
Get client
GET
Update client settings
PUT
Delete client
DELETE
Get client secret
GET
Update client authentication
PUT
Update OAuth2 flows
PUT
Update redirect URIs
PUT
Update web origins
PUT
Update token settings
PUT
Get client permissions
GET
Set client permissions
PUT
Switch whether a client may request the administrative scopes
PUT
List client sessions
GET
Get client logo info
GET
Upload client logo
POST
Delete client logo
DELETE
Get client logo image
GET
Audit Logs
Overview
Query audit logs
GET
Get audit event types
GET
Settings
Overview
Get general settings
GET
Update general settings
PUT
Get email settings
GET
Update email settings
PUT
Send test email
POST
Get session settings
GET
Update session settings
PUT
Get UI theme
GET
Update UI theme
PUT
Get token settings
GET
Update token settings
PUT
Get audit log settings
GET
Update audit log settings
PUT
Get signing keys
GET
Rotate signing keys
POST
Delete signing key
DELETE
Get phone countries
GET
Account API
Overview
Profile
Get own profile
GET
Update own profile
PUT
Email
Update own email
PUT
Send verification email
POST
Verify email
POST
Phone
Update own phone
PUT
Address
Update own address
PUT
Password
Change own password
PUT
Profile picture
Get own profile picture info
GET
Upload own profile picture
POST
Delete own profile picture
DELETE
Two-factor authentication
Start OTP enrollment
GET
Enable/disable OTP
PUT
Consents
List own consents
GET
Revoke own consent
DELETE
Sessions
List own sessions
GET
Terminate own session
DELETE
Sign-out
Prepare a sign-out
POST
Environment variables
Security
Troubleshooting
Invalid redirect_uri
The app gets no error back
invalid_scope
login_required
This refresh token has been revoked
Sign-out answers 403
Too many attempts or 429
Locked out of the admin console
Unable to load the configuration from the auth server
A user cannot reset their password
Certificates are not issued
CrashLoopBackOff or unable to create the database connection
Database TLS connection fails
PostgreSQL TLS variables stop startup
attempt to write a readonly database
Waiting for the migration lock, or marked dirty
Metrics are not scraped
Legacy flows
Implicit
ROPC
About
About
Contributing
License
llms.txt
llms-full.txt
GitHub
Select theme
Dark
Light
Auto
Overview
User Attributes
Section titled “User Attributes”
Custom user attributes (Admin API)
Operations
Section titled “Operations”
GET
/api/v1/admin/users/{id}/attributes
POST
/api/v1/admin/user-attributes
GET
/api/v1/admin/user-attributes/{id}
PUT
/api/v1/admin/user-attributes/{id}
DELETE
/api/v1/admin/user-attributes/{id}