Your suggested change has been received. Thank you.

close

Mail Config API (0.0.1)

Download OpenAPI specification:Download

Mail Config API documentation

Mail Config API

Get authorization config

Returns the authorization configuration (JWKS and JWT details).

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": {
    },
  • "cursor": "string"
}

Update authorization config

Updates the authorization configuration (JWKS and JWT details)

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
jwksUri
required
string

The URI of the JSON Web Key Set.

issuer
required
string

The URI of the JWT issuer.

audience
string

The expected audience of the JWT.

Responses

Request samples

Content type
application/json
{
  • "jwksUri": "string",
  • "issuer": "string",
  • "audience": "string"
}

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": {
    },
  • "cursor": "string"
}

Get authorization config

Returns the authorization configuration (JWKS and JWT details).

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": {
    },
  • "cursor": "string"
}

Update authorization config

Updates the authorization configuration (JWKS and JWT details)

Authorizations:
bearer
path Parameters
tenant
required
string

Your tenant code.

header Parameters
acting-tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter

tenant-id
string

Tenant code. Used when not passing the tenant code in the URL path parameter or no acting tenant

Request Body schema: application/json
jwksUri
required
string

The URI of the JSON Web Key Set.

issuer
required
string

The URI of the JWT issuer.

audience
string

The expected audience of the JWT.

Responses

Request samples

Content type
application/json
{
  • "jwksUri": "string",
  • "issuer": "string",
  • "audience": "string"
}

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "links": { },
  • "config": {
    },
  • "cursor": "string"
}