Skip to main content
GET
/
api
/
oauth2
/
authorize
Authorize
curl --request GET \
  --url https://api.rapidly.tech/api/oauth2/authorize
{
  "client": {
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "client_id": "<string>",
    "client_name": "<string>",
    "client_uri": "<string>",
    "logo_uri": "<string>",
    "tos_uri": "<string>",
    "policy_uri": "<string>"
  },
  "sub_type": "<string>",
  "sub": {
    "id": "<string>",
    "email": "jsmith@example.com",
    "avatar_url": "<string>"
  },
  "scopes": [
    "openid"
  ],
  "scope_display_names": {
    "openid": "OpenID",
    "profile": "Read your profile information",
    "email": "Read your email address",
    "web:read": "Web Read Access",
    "web:write": "Web Write Access",
    "user:write": "Delete your user account",
    "workspaces:read": "Read your workspaces",
    "workspaces:write": "Create or modify workspaces",
    "custom_fields:read": "Read custom fields",
    "custom_fields:write": "Create or modify custom fields",
    "shares:read": "Read shares",
    "shares:write": "Create or modify shares",
    "events:read": "Read events",
    "events:write": "Create events",
    "files:read": "Read file uploads",
    "files:write": "Create or modify file uploads",
    "customers:read": "Read customers",
    "customers:write": "Create or modify customers",
    "members:read": "Read members",
    "members:write": "Create or modify members",
    "customer_sessions:write": "Create or modify customer sessions",
    "member_sessions:write": "Create or modify member sessions",
    "payments:read": "Read payments",
    "metrics:read": "Read metrics",
    "webhooks:read": "Read webhooks",
    "webhooks:write": "Create or modify webhooks",
    "customer_portal:read": "Read your files and access",
    "customer_portal:write": "Manage your files and access",
    "notifications:read": "Read notifications",
    "notifications:write": "Mark notifications as read",
    "notification_recipients:read": "Read notification recipients",
    "notification_recipients:write": "Create or modify notification recipients",
    "workspace_access_tokens:read": "Read workspace access tokens",
    "workspace_access_tokens:write": "Create or modify workspace access tokens",
    "file_sharing:read": "Read file sharing sessions",
    "file_sharing:write": "Create or modify file sharing sessions"
  }
}

Response

200 - application/json

Successful Response

client
OAuth2ClientPublic · object
required

Subset of client fields safe for display during the consent screen.

sub_type
string
required
Allowed value: "user"
sub
AuthorizeUser · object
required
scopes
enum<string>[]
required

All OAuth2 scopes recognised by the platform.

Available options:
openid,
profile,
email,
user:write,
web:read,
web:write,
workspaces:read,
workspaces:write,
custom_fields:read,
custom_fields:write,
shares:read,
shares:write,
events:read,
events:write,
files:read,
files:write,
customers:read,
customers:write,
members:read,
members:write,
customer_sessions:write,
member_sessions:write,
payments:read,
metrics:read,
webhooks:read,
webhooks:write,
customer_portal:read,
customer_portal:write,
notifications:read,
notifications:write,
notification_recipients:read,
notification_recipients:write,
workspace_access_tokens:read,
workspace_access_tokens:write,
file_sharing:read,
file_sharing:write
scope_display_names
Scope Display Names · object