You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/security.md
+5-2Lines changed: 5 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ and guess what should contain `$password`. The `$method` can contain one of the
23
23
24
24
The required value of `$password` depends on the chosen `$method`. For `Github\Client::AUTH_URL_TOKEN`,
25
25
`Github\Client::AUTH_HTTP_TOKEN` and `Github\Client::JWT` methods you should provide the API token in
26
-
`$username` variable (`$password` is omitted in this particular case). For the
26
+
`$usernameOrToken` variable (`$password` is omitted in this particular case). For the
27
27
`Github\Client::AUTH_HTTP_PASSWORD`, you should provide the password of the account. When using `Github\Client::AUTH_URL_CLIENT_ID`
28
28
`$usernameOrToken` should contain your client ID, and `$password` should contain client secret.
29
29
@@ -47,7 +47,7 @@ Note however that GitHub describes this method as deprecated. In most case you s
47
47
48
48
To authenticate as an integration you need to supply a JSON Web Token with `Github\Client::AUTH_JWT` to request
49
49
and installation access token which is then usable with `Github\Client::AUTH_HTTP_TOKEN`. [Github´s integration
50
-
authentication docs](https://developer.github.com/early-access/integrations/authentication/) describe the flow in detail.
50
+
authentication docs](https://developer.github.com/apps/building-github-apps/authentication-options-for-github-apps/#authenticating-as-a-github-app) describe the flow in detail.
51
51
It´s important for integration requests to use the custom Accept header `application/vnd.github.machine-man-preview`.
52
52
53
53
The following sample code authenticates as an installation using [lcobucci/jwt](https://github.com/lcobucci/jwt/tree/3.2.0)
0 commit comments