Recurso

OAuth · Clientes socios

5 operaciones · base https://api.bestdoctorsrd.com

GET/v1/platform/oauth-clients

Lista los clientes socios

Devuelve qué clientes hay, de qué institución son y con qué ámbitos. Nunca devuelve el secreto de ninguno.

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaOAuthClientListOut
POST/v1/platform/oauth-clients

Da de alta un cliente OAuth

Crea el cliente ligado a una institución y con los ámbitos elegidos. La respuesta trae el `client_secret` en claro: es la única vez que sale del servidor.

Cuerpo obligatorio OAuthClientCreateIn

CampoTipoObl.
tenant_idstring
namestring
scopeslista de string

Respuestas

CódigoDescripciónDevuelve
201Respuesta correctaOAuthClientSecretOut
404La institución indicada no existe.
409La institución está suspendida.
422Ámbitos desconocidos o lista vacía.
GET/v1/platform/oauth-clients/scopes

Catálogo de ámbitos disponibles

Ámbitos que se pueden conceder a un cliente. Es la lista contra la que se valida el alta.

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctalista de OAuthScopeOut
POST/v1/platform/oauth-clients/{client_pk}/revoke

Revoca un cliente

Apaga el cliente y deja constancia de quién lo revocó, cuándo y por qué. Un cliente revocado no vuelve: se da de alta uno nuevo.

Parámetros

NombreEnTipoObl.
client_pkpathinteger

Cuerpo obligatorio OAuthClientRevokeIn

CampoTipoObl.
reasonstring

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaOAuthClientOut
404El cliente no existe.
409El cliente ya estaba revocado.
422Error de validaciónHTTPValidationError
POST/v1/platform/oauth-clients/{client_pk}/rotate-secret

Rota el secreto de un cliente

Genera un secreto nuevo y devuelve el valor en claro una sola vez. El anterior deja de servir en el acto. Si el cliente todavía no tenía identidad OAuth, se le crea aquí.

Parámetros

NombreEnTipoObl.
client_pkpathinteger

Respuestas

CódigoDescripciónDevuelve
200Respuesta correctaOAuthClientSecretOut
404El cliente no existe.
409El cliente está revocado o su institución está suspendida.
422Error de validaciónHTTPValidationError