get/oauth/apps/{clientId}

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/oauth/apps/{clientId}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

clientIdstring required

Query parameters

redirectUristring

If set, the response says whether this exact URI is registered for the app, so the consent screen can refuse before redirecting anywhere

Response

OK

clientIdstring required
namestring required
descriptionstring nullable required
iconUrlstring uri nullable required
homepageUrlstring uri nullable required
privacyPolicyUrlstring uri nullable required
termsOfServiceUrlstring uri nullable required
ownerOrgNamestring nullable required

Display name of the org that registered the app

approvedboolean required
status'PENDING_REVIEW' | 'APPROVED' | 'SUSPENDED' required

APPROVED: vetted by Anima. PENDING_REVIEW: not vetted, which every self-registered client starts as. SUSPENDED: refused everywhere: no new codes, no refreshes, and its live access tokens stop working.

redirectUriRegisteredboolean

Present when redirectUri was passed: whether it exactly matches one of the app's registered redirect URIs

Changes

No recorded changes to this operation across all 1 revision of this API.