Application

Represents an application that interfaces with the REST API to access accounts or post statuses.

Example 

{
  "name": "Test Application",
  "website": "https://app.example",
  "scopes": ["read", "write", "push"],
  "redirect_uri": "https://app.example/callback\nhttps://app.example/register",
  "redirect_uris": [
    "https://app.example/callback",
    "https://app.example/register"
  ]
}

Attributes

name

Description: The name of your application.
Type: String
Version history:
0.9.9 - added

website optional

Description: The website associated with your application.
Type: nullable String (URL)
Version history:
0.9.9 - added
3.5.1 - this property is now nullable

scopes

Description: The scopes for your application. This is the registered scopes string split on whitespace.
Type: Array of Strings
Version history:
4.3.0 - added

redirect_uris

Description: The registered redirection URI(s) for your application.
Type: Array of String (URLs or "urn:ietf:wg:oauth:2.0:oob" as values)
Version history:
4.3.0 - added

redirect_uri deprecated

Description: The registered redirection URI(s) for your application.
May contain \n characters when multiple redirect URIs are registered.
Type: String
Version history:
0.0.0 - added
4.3.0 - deprecated in favour of redirect_uris, since the value of this property is not a well-formed URI when multiple redirect URIs are registered

vapid_key deprecated

Description: Used for Push Streaming API. Returned with POST /api/v1/apps. Equivalent to WebPushSubscription#server_key and Instance#vapid_public_key
Type: String
Version history:
2.8.0 - added
4.3.0 - deprecated pending removal, please see api/v2/instance for this value (configuration.vapid.public_key)

CredentialApplication attributes

All Application attributes and the following:

client_id

Description: Client ID key, to be used for obtaining OAuth tokens
Type: String
Version history:
0.9.9 - added 4.3.0 - moved to CredentialApplication from Application

client_secret

Description: Client secret key, to be used for obtaining OAuth tokens
Type: String
Version history:
0.9.9 - added 4.3.0 - moved to CredentialApplication from Application

client_secret_expires_at

Description: When the client secret key will expire at, presently this always returns 0 indicating that OAuth Clients do not expire
Type: String
Version history:
4.3.0 - added

See also

apps API methods
Status (application attribute)
app/serializers/rest/application_serializer.rb
app/serializers/rest/credential_application_serializer.rb

Last updated · Improve this page