Skip to content

Commit 5c91d6e

Browse files
committed
feat: add Token Authentication
1 parent 7553097 commit 5c91d6e

1 file changed

Lines changed: 11 additions & 5 deletions

File tree

content/v2/overview/authentication.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,24 @@ title: API v2 - Overview - Authentication
55
# Authentication
66

77
SeeClickFix currently supports the following authentication methods for access to API v2.
8-
1. HTTP Basic Authentication
8+
1. Token Authentication
99
1. OAauth2 Authentication
1010

11-
### HTTP Basic Authentication
11+
### Token Authentication
12+
This method is appropriate for API access. It is a secret that is included as a request header.
1213

13-
This method is appropriate when the client has direct access to user credentials (username
14-
and password).
14+
Header Format:
15+
<pre class="terminal">
16+
Authorization: Bearer [token]
17+
</pre>
18+
19+
To create and manage Bearer Tokens for Authentication, visit [Password & Security](https://account.civicplus.com/security) and go to the Personal Access Token section. Personal Access Tokens are Bearer Tokens.
1520

1621
<pre class="terminal">
17-
$ curl -u "email@example.com:password" <%= root_version_url %>/profile
22+
$ curl -i https://seeclickfix.com/api/v2/profile -H "Authorization: Bearer test-08/12/2024-01/01/2025-xxxxxxxxxxxxxx"
1823
</pre>
1924

25+
2026
### OAuth2 Authentication
2127

2228
This method is appropriate when the client application is being used by multiple users

0 commit comments

Comments
 (0)