SecureAuth (incl. Cloudentity) Authorization Details API
The authorizationDetails API from SecureAuth (incl. Cloudentity) — 3 operation(s) for authorizationdetails.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/secureauth:secureauth-authorizationdetails-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: 'SecureAuth Admin API
The POST APIs support idempotency for safely retrying requests without accidentally performing the same operation twice.
To use idempotent requests:
1. Generate a unique idempotency key (32-255 characters long).
2. Include the key in the X-Idempotency-Key header of your POST request.
3. Retry failed requests with the same key within 1 minute.
Responses for replayed requests will include the X-Idempotent-Replayed: true header.'
title: SecureAuth Authorization Details API
version: latest
servers:
- url: https://localhost:8443/api/admin/default
tags:
- name: authorizationDetails
paths:
/authorization-details:
post:
description: Creates a new Authorization Detail object.
operationId: createAuthorizationDetail
parameters:
- description: A server will only return requested resources if the resource matches one of the listed ETag value
in: header
name: if-match
schema:
type: string
format: etag
- description: Unique identifier included in audit events for request tracking
in: header
name: x-correlation-id
schema:
type: string
- description: Key used to safely retry failed requests without duplicate processing
in: header
name: x-idempotency-key
schema:
type: string
responses:
'201':
$ref: '#/components/responses/AuthorizationDetail'
'400':
$ref: '#/components/responses/badRequestHTTPError'
'401':
$ref: '#/components/responses/unauthorizedHTTPError'
'403':
$ref: '#/components/responses/forbiddenHTTPError'
'404':
$ref: '#/components/responses/notFoundHTTPError'
'409':
$ref: '#/components/responses/unprocessableEntityHTTPError'
'422':
$ref: '#/components/responses/unprocessableEntityHTTPError'
'429':
$ref: '#/components/responses/tooManyRequestsHTTPError'
security:
- admin: []
summary: Create AuthorizationDetail
tags:
- authorizationDetails
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizationDetailWithServiceID'
/authorization-details/{authorizationDetailID}:
delete:
description: Deletes the authorization detail.
operationId: deleteAuthorizationDetail
parameters:
- description: A server will only return requested resources if the resource matches one of the listed ETag value
in: header
name: if-match
schema:
type: string
format: etag
- description: Unique identifier included in audit events for request tracking
in: header
name: x-correlation-id
schema:
type: string
- description: Key used to safely retry failed requests without duplicate processing
in: header
name: x-idempotency-key
schema:
type: string
- description: AuthorizationDetail ID
in: path
name: authorizationDetailID
required: true
schema:
type: string
responses:
'204':
description: ' Authorization Detail has been deleted'
'401':
$ref: '#/components/responses/unauthorizedHTTPError'
'403':
$ref: '#/components/responses/forbiddenHTTPError'
'404':
$ref: '#/components/responses/notFoundHTTPError'
'429':
$ref: '#/components/responses/tooManyRequestsHTTPError'
security:
- admin: []
summary: Delete AuthorizationDetail
tags:
- authorizationDetails
get:
description: Returns an Authorization Detail.
operationId: getAuthorizationDetail
parameters:
- description: A server will only return requested resources if the resource matches one of the listed ETag value
in: header
name: if-match
schema:
type: string
format: etag
- description: Unique identifier included in audit events for request tracking
in: header
name: x-correlation-id
schema:
type: string
- description: Key used to safely retry failed requests without duplicate processing
in: header
name: x-idempotency-key
schema:
type: string
- description: AuthorizationDetail ID
in: path
name: authorizationDetailID
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/AuthorizationDetailWithService'
'401':
$ref: '#/components/responses/unauthorizedHTTPError'
'403':
$ref: '#/components/responses/forbiddenHTTPError'
'404':
$ref: '#/components/responses/notFoundHTTPError'
'429':
$ref: '#/components/responses/tooManyRequestsHTTPError'
security:
- admin: []
summary: Get AuthorizationDetail
tags:
- authorizationDetails
put:
description: Updates the authorization detail
operationId: updateAuthorizationDetail
parameters:
- description: A server will only return requested resources if the resource matches one of the listed ETag value
in: header
name: if-match
schema:
type: string
format: etag
- description: Unique identifier included in audit events for request tracking
in: header
name: x-correlation-id
schema:
type: string
- description: Key used to safely retry failed requests without duplicate processing
in: header
name: x-idempotency-key
schema:
type: string
- description: AuthorizationDetail ID
in: path
name: authorizationDetailID
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/AuthorizationDetail'
'400':
$ref: '#/components/responses/badRequestHTTPError'
'401':
$ref: '#/components/responses/unauthorizedHTTPError'
'403':
$ref: '#/components/responses/forbiddenHTTPError'
'404':
$ref: '#/components/responses/notFoundHTTPError'
'409':
$ref: '#/components/responses/unprocessableEntityHTTPError'
'422':
$ref: '#/components/responses/unprocessableEntityHTTPError'
'429':
$ref: '#/components/responses/tooManyRequestsHTTPError'
security:
- admin: []
summary: Update AuthorizationDetail
tags:
- authorizationDetails
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizationDetail'
/servers/{wid}/authorization-details:
get:
description: List authorization details.
operationId: listAuthorizationDetails
parameters:
- description: A server will only return requested resources if the resource matches one of the listed ETag value
in: header
name: if-match
schema:
type: string
format: etag
- description: Unique identifier included in audit events for request tracking
in: header
name: x-correlation-id
schema:
type: string
- description: Key used to safely retry failed requests without duplicate processing
in: header
name: x-idempotency-key
schema:
type: string
- description: Authorization server id
in: path
name: wid
required: true
schema:
type: string
default: default
responses:
'200':
description: AuthorizationDetailsWithServices
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizationDetailsWithServices'
'401':
$ref: '#/components/responses/unauthorizedHTTPError'
'403':
$ref: '#/components/responses/forbiddenHTTPError'
'429':
$ref: '#/components/responses/tooManyRequestsHTTPError'
security:
- admin: []
summary: List authorization details
tags:
- authorizationDetails
components:
schemas:
AuthorizationDetail:
description: Authorization detail
properties:
authorization_server_id:
description: An authorization server (workspace) identifier holding the client application.
example: default
format: serverID
type: string
description:
description: Description
example: Authorization detail for payment initiation
type: string
id:
description: Authorization detail unique identifier
format: authorizationDetailID
type: string
metadata:
additionalProperties:
type: object
description: General purpose metadata
type: object
name:
description: Display name
example: Payment Initiation
type: string
schema:
$ref: '#/components/schemas/SupportedJSONSchema'
tenant_id:
description: ID of the tenant
example: default
format: tenantID
type: string
type:
$ref: '#/components/schemas/AuthorizationDetailType'
required:
- tenant_id
- authorization_server_id
- type
type: object
AuthorizationDetailWithServiceID:
properties:
authorization_server_id:
description: An authorization server (workspace) identifier holding the client application.
example: default
format: serverID
type: string
description:
description: Description
example: Authorization detail for payment initiation
type: string
id:
description: Authorization detail unique identifier
format: authorizationDetailID
type: string
metadata:
additionalProperties:
type: object
description: General purpose metadata
type: object
name:
description: Display name
example: Payment Initiation
type: string
schema:
$ref: '#/components/schemas/SupportedJSONSchema'
service_id:
description: Service id
format: serviceID
type: string
tenant_id:
description: ID of the tenant
example: default
format: tenantID
type: string
type:
$ref: '#/components/schemas/AuthorizationDetailType'
required:
- tenant_id
- authorization_server_id
- type
- service_id
type: object
AuthorizationDetailWithService:
properties:
authorization_server_id:
description: An authorization server (workspace) identifier holding the client application.
example: default
format: serverID
type: string
description:
description: Description
example: Authorization detail for payment initiation
type: string
id:
description: Authorization detail unique identifier
format: authorizationDetailID
type: string
metadata:
additionalProperties:
type: object
description: General purpose metadata
type: object
name:
description: Display name
example: Payment Initiation
type: string
schema:
$ref: '#/components/schemas/SupportedJSONSchema'
service:
$ref: '#/components/schemas/Service'
tenant_id:
description: ID of the tenant
example: default
format: tenantID
type: string
type:
$ref: '#/components/schemas/AuthorizationDetailType'
required:
- tenant_id
- authorization_server_id
- type
type: object
ServiceCapability:
type: string
AuthorizationDetailType:
type: string
Error:
description: HTTP error response
properties:
details:
type: object
error:
type: string
error_code:
type: string
status_code:
format: int64
type: integer
type: object
AuthorizationDetailsWithServices:
properties:
authorization_details:
description: list of authorization details
items:
$ref: '#/components/schemas/AuthorizationDetailWithService'
type: array
type: object
Service:
properties:
audience_mode:
description: Controls which audience is injected into access tokens for scopes mapped to this service
enum:
- spiffe
- custom
- none
example: spiffe
type: string
authorization_server_id:
description: Authorization server identifier
example: my-server
format: serverID
type: string
capabilities:
description: Service capabilities
items:
$ref: '#/components/schemas/ServiceCapability'
type: array
custom_audience:
description: Custom service audience
example: https://api.example.com
type: string
description:
description: Service description
example: Service description
type: string
gateway_id:
description: Gateway identifier
example: gateway-1
format: gatewayID
type: string
id:
description: A unique identifier of a service
example: service-1
format: serviceID
type: string
name:
description: Service name
example: My service
type: string
system:
description: '`true` when the service is a system service'
example: false
type: boolean
tenant_id:
description: Tenant identifier
example: my-company
format: tenantID
type: string
type:
default: user
description: Service type
enum:
- oauth2
- oidc
- system
- user
- openbanking
type: string
updated_at:
description: The date of service update
format: date-time
type: string
with_specification:
description: '`true` when the service has the OpenAPI 3.0 specification'
type: boolean
type: object
SupportedJSONSchema:
properties:
additionalProperties:
type: boolean
allOf:
items:
$ref: '#/components/schemas/SupportedJSONSchema'
type: array
anyOf:
items:
$ref: '#/components/schemas/SupportedJSONSchema'
type: array
const:
type: string
contains:
$ref: '#/components/schemas/SupportedJSONSchema'
dependentRequired:
additionalProperties:
items:
type: string
type: array
type: object
dependentSchemas:
additionalProperties:
$ref: '#/components/schemas/SupportedJSONSchema'
type: object
description:
type: string
else:
$ref: '#/components/schemas/SupportedJSONSchema'
enum:
items:
type: string
type: array
exclusiveMaximum:
format: int64
type: integer
exclusiveMinimum:
format: int64
type: integer
hidden:
type: boolean
if:
$ref: '#/components/schemas/SupportedJSONSchema'
items:
$ref: '#/components/schemas/SupportedJSONSchema'
maxContains:
format: int64
type: integer
maxItems:
description: arrays
format: int64
type: integer
maxLength:
description: strings
format: int64
type: integer
maxProperties:
description: objects
format: int64
type: integer
maximum:
format: int64
type: integer
minContains:
format: int64
type: integer
minItems:
format: int64
type: integer
minLength:
format: int64
type: integer
minProperties:
format: int64
type: integer
minimum:
format: int64
type: integer
multipleOf:
description: numeric
format: int64
type: integer
not:
$ref: '#/components/schemas/SupportedJSONSchema'
oneOf:
items:
$ref: '#/components/schemas/SupportedJSONSchema'
type: array
pattern:
type: string
patternProperties:
additionalProperties:
$ref: '#/components/schemas/SupportedJSONSchema'
type: object
properties:
additionalProperties:
$ref: '#/components/schemas/SupportedJSONSchema'
type: object
propertyNames:
$ref: '#/components/schemas/SupportedJSONSchema'
required:
items:
type: string
type: array
then:
$ref: '#/components/schemas/SupportedJSONSchema'
title:
type: string
type:
description: any
type: string
uniqueItems:
type: boolean
type: object
responses:
unprocessableEntityHTTPError:
description: Unprocessable entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
AuthorizationDetailWithService:
description: AuthorizationDetailWithService
headers:
etag:
description: 'The ETag HTTP header is an identifier for a specific version of a resource
in:header'
schema:
type: string
format: etag
x-external-error:
description: 'Indicates that a 5xx error was caused by tenant-provided code
in:header'
schema:
type: string
x-trace-id:
description: 'OpenTelemetry trace identifier
in:header'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizationDetailWithService'
notFoundHTTPError:
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
forbiddenHTTPError:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
AuthorizationDetail:
description: AuthorizationDetail
headers:
etag:
description: 'The ETag HTTP header is an identifier for a specific version of a resource
in:header'
schema:
type: string
format: etag
x-external-error:
description: 'Indicates that a 5xx error was caused by tenant-provided code
in:header'
schema:
type: string
x-trace-id:
description: 'OpenTelemetry trace identifier
in:header'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizationDetailWithServiceID'
unauthorizedHTTPError:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tooManyRequestsHTTPError:
description: Too many requests
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
badRequestHTTPError:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
admin:
type: oauth2
flows:
authorizationCode:
scopes: {}
authorizationUrl: /default/admin/oauth2/authorize
tokenUrl: /default/admin/oauth2/token