Create an Application

Creates an Application and its credentials - clientId and clientSecret.

POST /v1/applications

Error

A valid request URL is required to generate request examples

201

{
  "createdAt": "2021-09-01T00:00:00.000Z",
  "clientId": "clientId",
  "name": "Midaz",
  "description": "Midaz Used By Application X",
  "clientSecret": "clientSecret",
  "id": "00000000-0000-0000-0000-000000000000"
}

Autorizaciones

Authorization · string · header · requerido

Bearer authentication. Send Authorization: Bearer .

Cuerpo

application/json

Application Input

ApplicationInput payload

description · string · requerido

Description field for any annotation of the application.

Ejemplo:

"Identity Used By BR Sisbajud"

name · string

Name is the DEPRECATED alias of Target, kept so every existing caller keeps working unchanged. Supply Target instead. When both are present Target wins.

Ejemplo:

"midaz"

source · string

Source is the service that will CONSUME this credential — the caller. It must also match the available-applications catalog. Optional: when supplied the application becomes pairwise, exactly like the multi-tenant provisioner builds it, and the server records the source as the sourceService claim so the declarations reconciler can answer "who is declaring" from the token instead of inferring it from DisplayName. When omitted the application keeps the pre-existing single-tenant shape.

Ejemplo:

"br-sisbajud"

target · string

Target is the service this credential is issued FOR — the callee. It must match an application exposed by GET /v1/applications/available. The catalog may evolve over time. Required (directly or through the Name alias).

Ejemplo:

"plugin-identity"

Respuesta

201

application/json

Created

ApplicationResponse payload

clientId · string

clientSecret · string

#nosec G117 -- auth service, field must be in JSON response

createdAt · string

Ejemplo:

"2021-09-01T00:00:00.000Z"

description · string

Ejemplo:

"Midaz Used By Application X"

id · string

Ejemplo:

"00000000-0000-0000-0000-000000000000"

name · string

Ejemplo:

"Midaz"