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: lib/Service/SSO.php
+17-5Lines changed: 17 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -106,9 +106,13 @@ public function deleteConnection(
106
106
* Initiates the single sign-on flow.
107
107
* @param array<string>|null $providerScopes Additional OAuth scopes to request from the identity provider. Only applicable when using OAuth connections.
108
108
* @param array<string, string>|null $providerQueryParams Key/value pairs of query parameters to pass to the OAuth provider. Only applicable when using OAuth connections.
109
+
* @param string $clientId The unique identifier of the WorkOS environment client.
109
110
* @param string|null $domain (deprecated) Deprecated. Use `connection` or `organization` instead. Used to initiate SSO for a connection by domain. The domain must be associated with a connection in your WorkOS environment.
110
111
* @param \WorkOS\Resource\SSOProvider|null $provider Used to initiate OAuth authentication with Google, Microsoft, GitHub, or Apple.
111
112
* @param string $redirectUri Where to redirect the user after they complete the authentication process. You must use one of the redirect URIs configured via the [Redirects](https://dashboard.workos.com/redirects) page on the dashboard.
113
+
* @param string $responseType The only valid option for the response type parameter is `"code"`.
114
+
*
115
+
* The `"code"` parameter value initiates an [authorization code grant type](https://tools.ietf.org/html/rfc6749#section-4.1). This grant type allows you to exchange an authorization code for an access token during the redirect that takes place after a user has authenticated with an identity provider.
112
116
* @param string|null $state An optional parameter that can be used to encode arbitrary information to help restore application state between redirects. If included, the redirect URI received from WorkOS will contain the exact `state` that was passed.
113
117
* @param string|null $connection Used to initiate SSO for a connection. The value should be a WorkOS connection ID.
114
118
*
@@ -122,7 +126,9 @@ public function deleteConnection(
* Get an access token along with the user [Profile](https://workos.com/docs/reference/sso/profile) using the code passed to your [Redirect URI](https://workos.com/docs/reference/sso/get-authorization-url/redirect-uri).
237
+
* @param string $clientId The client ID of the WorkOS environment.
238
+
* @param string $clientSecret The client secret of the WorkOS environment.
231
239
* @param string $code The authorization code received from the authorization callback.
240
+
* @param string $grantType The grant type for the token request.
0 commit comments