AuthenticationApi
in package
AuthenticationApi Class Doc Comment
Tags
Table of Contents
- $apiClient : ApiClient
- API Client
- __construct() : void
- Constructor
- deleteSocialLogin() : mixed
- Operation deleteSocialLogin
- deleteSocialLoginWithHttpInfo() : array<string|int, mixed>
- Operation deleteSocialLoginWithHttpInfo
- getApiClient() : ApiClient
- Get API client
- getOAuthToken() : OauthAccess
- Operation getOAuthToken
- getOAuthTokenWithHttpInfo() : array<string|int, mixed>
- Operation getOAuthTokenWithHttpInfo
- listSocialLogins() : UserSocialIdResult
- Operation listSocialLogins
- listSocialLoginsWithHttpInfo() : array<string|int, mixed>
- Operation listSocialLoginsWithHttpInfo
- login() : LoginInformation
- Operation login
- loginWithHttpInfo() : array<string|int, mixed>
- Operation loginWithHttpInfo
- revokeOAuthToken() : mixed
- Operation revokeOAuthToken
- revokeOAuthTokenWithHttpInfo() : array<string|int, mixed>
- Operation revokeOAuthTokenWithHttpInfo
- setApiClient() : self
- Set the API client
- updatePassword() : mixed
- Operation updatePassword
- updatePasswordWithHttpInfo() : array<string|int, mixed>
- Operation updatePasswordWithHttpInfo
- updateResourcePath() : string
- Update $resourcePath with $
- updateSocialLogin() : mixed
- Operation updateSocialLogin
- updateSocialLoginWithHttpInfo() : array<string|int, mixed>
- Operation updateSocialLoginWithHttpInfo
Properties
$apiClient
API Client
protected
ApiClient
$apiClient
instance of the ApiClient
Methods
__construct()
Constructor
public
__construct([ApiClient|null $apiClient = null ]) : void
Parameters
- $apiClient : ApiClient|null = null
-
The api client to use
Return values
void —deleteSocialLogin()
Operation deleteSocialLogin
public
deleteSocialLogin(string|null $account_id, string|null $user_id[, SocialAccountInformation $social_account_information = null ]) : mixed
Deletes user's social account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $social_account_information : SocialAccountInformation = null
-
(optional)
Tags
Return values
mixed —deleteSocialLoginWithHttpInfo()
Operation deleteSocialLoginWithHttpInfo
public
deleteSocialLoginWithHttpInfo(string|null $account_id, string|null $user_id[, SocialAccountInformation $social_account_information = null ]) : array<string|int, mixed>
Deletes user's social account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $social_account_information : SocialAccountInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getApiClient()
Get API client
public
getApiClient() : ApiClient
Return values
ApiClient —get the API client
getOAuthToken()
Operation getOAuthToken
public
getOAuthToken() : OauthAccess
Creates an authorization token.
Tags
Return values
OauthAccess —getOAuthTokenWithHttpInfo()
Operation getOAuthTokenWithHttpInfo
public
getOAuthTokenWithHttpInfo() : array<string|int, mixed>
Creates an authorization token.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\OauthAccess, HTTP status code, HTTP response headers (array of strings)
listSocialLogins()
Operation listSocialLogins
public
listSocialLogins(string|null $account_id, string|null $user_id) : UserSocialIdResult
Gets a list of a user's social accounts.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
Tags
Return values
UserSocialIdResult —listSocialLoginsWithHttpInfo()
Operation listSocialLoginsWithHttpInfo
public
listSocialLoginsWithHttpInfo(string|null $account_id, string|null $user_id) : array<string|int, mixed>
Gets a list of a user's social accounts.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserSocialIdResult, HTTP status code, HTTP response headers (array of strings)
login()
Operation login
public
login([LoginOptions $options = null ]) : LoginInformation
Gets login information for a specified user.
Parameters
- $options : LoginOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
LoginInformation —loginWithHttpInfo()
Operation loginWithHttpInfo
public
loginWithHttpInfo([LoginOptions $options = null ]) : array<string|int, mixed>
Gets login information for a specified user.
Parameters
- $options : LoginOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\LoginInformation, HTTP status code, HTTP response headers (array of strings)
revokeOAuthToken()
Operation revokeOAuthToken
public
revokeOAuthToken() : mixed
Revokes an authorization token.
Tags
Return values
mixed —revokeOAuthTokenWithHttpInfo()
Operation revokeOAuthTokenWithHttpInfo
public
revokeOAuthTokenWithHttpInfo() : array<string|int, mixed>
Revokes an authorization token.
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
setApiClient()
Set the API client
public
setApiClient(ApiClient $apiClient) : self
Parameters
- $apiClient : ApiClient
-
set the API client
Return values
self —updatePassword()
Operation updatePassword
public
updatePassword(string|null $login_part[, UserPasswordInformation $user_password_information = null ]) : mixed
Updates the password for a specified user.
Parameters
- $login_part : string|null
-
Currently, only the value password is supported.
- $user_password_information : UserPasswordInformation = null
-
(optional)
Tags
Return values
mixed —updatePasswordWithHttpInfo()
Operation updatePasswordWithHttpInfo
public
updatePasswordWithHttpInfo(string|null $login_part[, UserPasswordInformation $user_password_information = null ]) : array<string|int, mixed>
Updates the password for a specified user.
Parameters
- $login_part : string|null
-
Currently, only the value password is supported.
- $user_password_information : UserPasswordInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
updateResourcePath()
Update $resourcePath with $
public
updateResourcePath(string $resourcePath, string $baseName, string $paramName) : string
Parameters
- $resourcePath : string
-
the resource path to use
- $baseName : string
-
the base name param
- $paramName : string
-
the parameter name
Return values
string —updateSocialLogin()
Operation updateSocialLogin
public
updateSocialLogin(string|null $account_id, string|null $user_id[, SocialAccountInformation $social_account_information = null ]) : mixed
Adds social account for a user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $social_account_information : SocialAccountInformation = null
-
(optional)
Tags
Return values
mixed —updateSocialLoginWithHttpInfo()
Operation updateSocialLoginWithHttpInfo
public
updateSocialLoginWithHttpInfo(string|null $account_id, string|null $user_id[, SocialAccountInformation $social_account_information = null ]) : array<string|int, mixed>
Adds social account for a user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $social_account_information : SocialAccountInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)