- Print
- DarkLight
b2_authorize_account
- Print
- DarkLight
Used to log in to the Partner API. Returns an authorization token that can be used for Partner API operationn and a URL that should be used as the base URL for subsequent API calls.
You'll find the Master Application Key on the App Keys page on the website. When using the Master Application Key, use your "master application keyID" and the "applicationKey" you created from the website.
HTTP basic authentication with the Master Application Key ID as user ID and the corresponding Application Key as password.
Most tools accept the user ID and password, but you can construct the value for the Authorization header as follows:
- The Application Key ID and Application Key are combined into a string in the format "applicationKeyId:applicationKey".
- The combined string is Base64 encoded.
- "Basic " is put before the encoded string.
The request succeeded.
The identifier for the account.
An authorization token to use with all Partner API calls, other than b2_authorize_account, that need an Authorization header. This authorization token is valid for at most 24 hours.
Expiration timestamp of application key.
An object containing the groupsApiUrl
, which is the baseUrl for all Partner API calls.
A list of strings, each one naming a capability the new key should have.
status | code | description |
---|---|---|
400 | bad_request | The request had the wrong fields or illegal values. The message returned with the error will describe the problem. |
The numeric HTTP status code. Always matches the status in the HTTP response.
A single-identifier code that identifies the error.
A human-readable message, in English, saying what went wrong.
status | code | description |
---|---|---|
401 | unauthorized | The applicationKeyId and/or the applicationKey are wrong. |
401 | unsupported | The applicationKeyId is valid, but cannot be used with this version of the Partner API. The message contains information about what the problem is. |