public class Authentication extends Object
Constructor and Description |
---|
Authentication(NetworkConnectionManager connection,
APISession apiSession) |
Modifier and Type | Method and Description |
---|---|
void |
authorizeOAuth2V30(String client_id,
String redirect_uri,
String response_type)
Get authorization code.
|
AuthenticationParametersJson |
getAuthenticationParametersV30(String clientId,
String userEmail)
Gets the method used to authenticate the user session, whether with the
BlackBerry Workspaces servers or with an oauth2 server.
|
OidcPublicKeyResultJson |
getOIDCPublicKeyV30()
Account Registration status
|
GetOrRefreshAccessTokenResponseJson |
getOrRefreshAccessTokenByPostV30(String client_id,
String client_secret,
String code,
String grant_type,
String redirect_uri,
String refresh_token,
Set<String> scope)
Gets or refreshes an Access token by using POST.
|
GetOrRefreshAccessTokenResponseJson |
getOrRefreshAccessTokenV30(String client_id,
String client_secret,
String code,
String grant_type,
String redirect_uri,
String refresh_token,
Set<String> scope)
Get or refresh an Access token.
|
AccountCreationStatusResultJson |
getUsernamePasswordAccountCreationStatusV30(AccountCreationStatusRequestJson accountCreationStatusRequestJson)
Account Registration status
|
public Authentication(NetworkConnectionManager connection, APISession apiSession)
public void authorizeOAuth2V30(String client_id, String redirect_uri, String response_type)
client_id
- The identifier for the application making the
request.redirect_uri
- A URL where an application where an application
should be redirected after a users has successfully been authenticated.response_type
- An OAuth Response Type. It should be set to
"code".public AuthenticationParametersJson getAuthenticationParametersV30(String clientId, String userEmail)
clientId
- Identifier for the client application to fetch
parameters for. If no value is provideuserEmail
- Email address of the user to fetch the Authentication
parameters for. If no value is provided returns the parameters for the
organization.public OidcPublicKeyResultJson getOIDCPublicKeyV30()
public GetOrRefreshAccessTokenResponseJson getOrRefreshAccessTokenByPostV30(String client_id, String client_secret, String code, String grant_type, String redirect_uri, String refresh_token, Set<String> scope)
client_id
- The identifier for the application making the
request.client_secret
- The client secret or password created for the
application identified by client_id.code
- The code provided on the redirected URL after
authentication. The code is only used when getting an Access Token, not
when refreshing a token.grant_type
- An OAuth Grant Type. Currently only
"authorization_code" and "refresh_token" are supported.
"authorization_code" should be used when making a request to
authenticate a user and get a new Access Token. "refresh_token" is used
when refreshing an Access Token after the current token has expired.redirect_uri
- A URL where an application where an application
should be redirected after a users has successfully been authenticated.refresh_token
- A Refresh Token previously obtained from the
server after authenticating a user. The Refresh Token is used to obtain
a new Access Token and Refresh Token after an existing Access Token has
expired.scope
- Not currently used.public GetOrRefreshAccessTokenResponseJson getOrRefreshAccessTokenV30(String client_id, String client_secret, String code, String grant_type, String redirect_uri, String refresh_token, Set<String> scope)
client_id
- The identifier for the application making the
request.client_secret
- The client secret or password created for the
application identified by client_id.code
- The code provided on the redirected URL after
authentication. The code is only used when getting an Access Token, not
when refreshing a token.grant_type
- An OAuth Grant Type. Currently only
"authorization_code" and "refresh_token" are supported.
"authorization_code" should be used when making a request to
authenticate a user and get a new Access Token. "refresh_token" is used
when refreshing an Access Token after the current token has expired.redirect_uri
- A URL where an application where an application
should be redirected after a users has successfully been authenticated.refresh_token
- A Refresh Token previously obtained from the
server after authenticating a user. The Refresh Token is used to obtain
a new Access Token and Refresh Token after an existing Access Token has
expired.scope
- Not currently used.public AccountCreationStatusResultJson getUsernamePasswordAccountCreationStatusV30(AccountCreationStatusRequestJson accountCreationStatusRequestJson)
accountCreationStatusRequestJson
- Copyright © 2019. All rights reserved.