Index | BlackBerry Workspaces SDK |
Name | Path | Version | Description |
---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
getAuthenticationParametersV30Gets the method used to authenticate the user session, whether with the BlackBerry Workspaces servers or with an oauth2 server. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /3.0/authentication/parameters | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | AuthenticationParameters | ||
Query parameters:
clientId: String - Identifier for the client application to fetch parameters for. If no value is provide. (optional, default: "").
userEmail: String - Email address of the user to fetch the Authentication parameters for. If no value is provided returns the parameters for the organization. (optional, default: ""). |
|||
|
getOIDCPublicKeyV30Account Registration status |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /3.0/authentication/oidc/jwk/publicKey | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | OidcPublicKeyResult | ||
|
getOrRefreshAccessTokenByPostV30Gets or refreshes an Access token by using POST. This method is used as part of authenticating using the OAuth2 protocol. After initially authenticating a a user, this method can be used to obtain an Access token and a Refresh token using the "code" returned on the redirect URL. If an application had previously retrieved an Access token and Refresh token, and the Access token expires, this method can be used to obtain a fresh set of tokens by passing the Refresh token obtained previously. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/authentication/token | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | GetOrRefreshAccessTokenResponse | ||
Data form parameters:
client_id: String - The identifier for the application making the request.
client_secret: String - The client secret or password created for the application identified by client_id. code: String - 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: String - 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: String - A URL where an application where an application should be redirected after a users has successfully been authenticated. refresh_token: String - 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: Set |
|||
|
getOrRefreshAccessTokenV30Get or refresh an Access token. This method is used as part of authenticating using the OAuth2 protocol. After initially authenticating a a user, this method can be used to obtain an Access token and a Refresh token using the "code" returned on the redirect URL. If an application had previously retrieved an Access token and Refresh token, and the Access token expires, this method can be used to obtain a fresh set of tokens by passing the Refresh token obtained previously. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /3.0/authentication/token | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | GetOrRefreshAccessTokenResponse | ||
Query parameters:
client_id: String - The identifier for the application making the request.
client_secret: String - The client secret or password created for the application identified by client_id. code: String - 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: String - 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: String - A URL where an application where an application should be redirected after a users has successfully been authenticated. refresh_token: String - 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: Set |
|||
|
getUsernamePasswordAccountCreationStatusV30Account Registration status |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/authentication/account/creation/status | ||
Request Body: | AccountCreationStatusRequest | ||
Response Headers: | N/A | ||
Response Body: | AccountCreationStatusResult | ||
|