View OAuth client

Overview

Returns the details of a single OAuth client owned by the caller. The secret is partially masked (middle third replaced with *). Returns 403 if the caller is not the client's creator.

Prerequisites

A bearer token in the Authorization header.

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

POST /api/v1/sso/view/client

Authentication

Requires a bearer token in the Authorization: Bearer <bearer-token> header.
bearer token. Owner-scoped — only the creator may view details.

Rate limit

No rate limit.

Request body

Field	Type	Required	Description
`client_id`	string	Required	Must be an existing OAuth client.

{
  "client_id": "<ssoClientId>"
}

How it works

200 with the client (masked secret). 403 if not owner. 422 if client_id does not exist.

Response

200 OK · `200`

{
  "data": {
    "status": "success",
    "client": {
      "id": "<oauth-client-id>",
      "owner_type": "App\\Models\\User",
      "owner_id": 3,
      "name": "test",
      "provider": null,
      "redirect_uris": [
        "https://google.com",
        "https://google2.com"
      ],
      "grant_types": [
        "authorization_code",
        "refresh_token"
      ],
      "revoked": false,
      "created_at": "2026-06-22T10:07:47.000000Z",
      "updated_at": "2026-06-22T10:07:47.000000Z",
      "secret": "<masked-secret>"
    }
  }
}

403 Forbidden (not owner) · `403`

{
  "message": "Forbidden",
  "status": "error",
  "errors": "Permission denied! The creator has the ability to view details."
}

422 Validation error · `422`

{
  "message": "The selected client id is invalid.",
  "errors": {
    "client_id": [
      "The selected client id is invalid."
    ]
  }
}

Errors

Status	Meaning
`401`	The bearer token is missing, expired or invalid
`403`	Forbidden (not owner)
`422`	Validation error
`500`	Unexpected server error

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/sso/view/client" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"client_id": "<ssoClientId>"}'

Updated 18 days ago

Did this page help you?