Skip to content

Commit c51dd6f

Browse files
https-richardyhttps-richardy
committed
this commit introduces comprehensive errors reference documentation
1 parent 635ac51 commit c51dd6f

1 file changed

Lines changed: 100 additions & 0 deletions

File tree

‎Documentation/errors-reference.md‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# ERRORS REFERENCE
2+
3+
Federation Gateway is designed to provide clear, actionable error feedback for every stage of the identity and access management lifecycle. This document serves as a comprehensive reference for all error codes that may be encountered when interacting with the platform, whether through the backend or SDK. Each error is accompanied by a description, a likely cause, and guidance on how to resolve or avoid the issue.
4+
5+
---
6+
7+
## AUTHENTICATION ERRORS
8+
9+
| Code | Description | Cause | Resolution |
10+
|----------------|--------------------------------------------------------------------|------------------------------------------------------------|----------------------------------------------|
11+
| #ERROR-32B37 | The token format is invalid or the token is malformed. | Token is missing, corrupted, or not JWT. | Ensure a valid token is provided. |
12+
| #ERROR-5F736 | The token has expired. | Token lifetime exceeded. | Request a new token. |
13+
| #ERROR-FB8E4 | The token signature is invalid. | Token was tampered or signed with wrong key. | Check signing keys and token integrity. |
14+
| #ERROR-1A9C3 | The token issuer is invalid. | Token was issued by an untrusted authority. | Use tokens from the configured authority. |
15+
| #ERROR-2C0D9 | The provided refresh token is invalid, expired, or already used. | Refresh token is wrong, expired, or reused. | Request a new refresh token. |
16+
| #ERROR-60CBC | Logout failed: the refresh token is invalid, expired, or reused. | Logout attempted with invalid/expired refresh token. | Re-authenticate and try again. |
17+
| #ERROR-A7E7C | The provided credentials are invalid. | Wrong client/user credentials. | Check credentials and try again. |
18+
| #ERROR-0AF50 | The client was not found. | ClientId does not exist or is misconfigured. | Verify client registration. |
19+
| #ERROR-D5D7C | The provided client credentials are invalid. | Client secret is wrong or missing. | Check client credentials. |
20+
| #ERROR-9B3E1 | Does not contain valid authentication credentials. | No Authorization header or invalid credentials. | Provide valid credentials. |
21+
| #ERROR-04A2F | The user was not found. | User does not exist or was deleted. | Check user existence or create user. |
22+
23+
---
24+
25+
## AUTHORIZATION ERRORS
26+
27+
| Code | Description | Cause | Resolution |
28+
|----------------|--------------------------------------------------------------------|------------------------------------------------------------|----------------------------------------------|
29+
| #ERROR-F8EBC | The specified redirect URI is not registered or allowed for realm. | Redirect URI not whitelisted for client/realm. | Register the redirect URI. |
30+
| #ERROR-C9D0A | The provided authorization code is invalid, expired, or used. | Code is wrong, expired, or already used. | Request a new authorization code. |
31+
| #ERROR-F4EB5 | The specified authorization grant type is not supported. | Grant type not implemented or allowed. | Use a supported grant type. |
32+
| #ERROR-5F5B3 | The authorization code has expired. | Code lifetime exceeded. | Request a new code. |
33+
| #ERROR-DDA70 | The provided code verifier does not match the code challenge. | PKCE code verifier mismatch. | Use correct code verifier. |
34+
35+
---
36+
37+
## GROUP ERRORS
38+
39+
| Code | Description | Cause | Resolution |
40+
|----------------|--------------------------------------------------------------------|------------------------------------------------------------|----------------------------------------------|
41+
| #ERROR-1C6F3 | The group with the specified name already exists. | Group name conflict. | Use a different group name. |
42+
| #ERROR-9C69E | The group already has the specified permission assigned. | Permission already linked to group. | No action needed or remove duplicate. |
43+
| #ERROR-4D2E2 | The group with the specified ID does not exist. | Group ID is wrong or deleted. | Check group existence. |
44+
| #ERROR-C2FB0 | The group does not have the specified permission assigned. | Permission not linked to group. | Assign permission before removing. |
45+
46+
---
47+
48+
## IDENTITY ERRORS
49+
50+
| Code | Description | Cause | Resolution |
51+
|----------------|--------------------------------------------------------------------|------------------------------------------------------------|----------------------------------------------|
52+
| #ERROR-DC3B1 | The user with the specified username already exists. | Username conflict. | Use a unique username. |
53+
54+
---
55+
56+
## PERMISSION ERRORS
57+
58+
| Code | Description | Cause | Resolution |
59+
|----------------|--------------------------------------------------------------------|------------------------------------------------------------|----------------------------------------------|
60+
| #ERROR-93F4A | The permission with the specified name already exists. | Permission name conflict. | Use a different permission name. |
61+
| #ERROR-7B1E2 | The permission name is reserved by the system. | Attempt to use reserved name. | Choose another name. |
62+
| #ERROR-93697 | The specified permission does not exist. | Permission not found. | Check permission existence. |
63+
64+
---
65+
66+
## REALM ERRORS
67+
68+
| Code | Description | Cause | Resolution |
69+
|----------------|--------------------------------------------------------------------|------------------------------------------------------------|----------------------------------------------|
70+
| #ERROR-8B1C5 | No HTTP context available to retrieve realm information. | Request outside HTTP context. | Ensure request is within HTTP context. |
71+
| #ERROR-2FB9A | The specified realm does not exist. | Realm not found. | Check realm existence. |
72+
| #ERROR-B2E42 | Realm header is missing from the HTTP request. | Missing or malformed header. | Add correct realm header. |
73+
| #ERROR-F98CE | A realm with the same name already exists. | Realm name conflict. | Use a unique realm name. |
74+
| #ERROR-F23E2 | The realm already has the specified permission assigned. | Permission already linked to realm. | No action needed or remove duplicate. |
75+
| #ERROR-C2FB0 | The realm does not have the specified permission assigned. | Permission not linked to realm. | Assign permission before removing. |
76+
77+
---
78+
79+
## SCOPE ERRORS
80+
81+
| Code | Description | Cause | Resolution |
82+
|----------------|--------------------------------------------------------------------|------------------------------------------------------------|----------------------------------------------|
83+
| #ERROR-8D128 | The scope with the specified name already exists. | Scope name conflict. | Use a different scope name. |
84+
| #ERROR-903F9 | The scope with the specified name does not exist. | Scope not found. | Check scope existence. |
85+
86+
---
87+
88+
## USER ERRORS
89+
90+
| Code | Description | Cause | Resolution |
91+
|----------------|--------------------------------------------------------------------|------------------------------------------------------------|----------------------------------------------|
92+
| #ERROR-E6B32 | The specified user does not exist. | User not found. | Check user existence. |
93+
| #ERROR-33066 | The user is already a member of the specified group. | User already in group. | No action needed or remove duplicate. |
94+
| #ERROR-44DEC | The user already has the specified permission assigned. | Permission already linked to user. | No action needed or remove duplicate. |
95+
| #ERROR-C2FB0 | The user does not have the specified permission assigned. | Permission not linked to user. | Assign permission before removing. |
96+
| #ERROR-0E56E | The user is not a member of the specified group. | User not in group. | Add user to group before removing. |
97+
98+
---
99+
100+
This reference is intended to help developers and integrators quickly identify, understand, and resolve errors encountered when working with Federation Gateway. For further details, consult the main documentation or open an issue with the error code and context.

0 commit comments

Comments
 (0)