You're in Good Company
Developers from all industries use our platform to build integrations and custom applications.
operationId: list-files
description: List all of the files uploaded to the portal
/developer:
get:
summary: Get Logged-in Developer
tags:
- developer
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
properties:
updated_at:
type: number
meta:
type: string
minLength: 1
created_at:
type: number
email:
type: string
minLength: 1
consumer:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
id:
type: string
minLength: 1
status:
type: number
required:
- updated_at
- meta
- created_at
- email
- consumer
- id
- status
x-examples:
example-1:
updated_at: 1622818516
meta: '{"full_name":"User"}'
created_at: 1622818473
email: user@example.com
consumer:
id: 06e5ea74-211e-4454-92cb-3f99bce4db10
id: 7581dec6-3f16-4509-86ef-b5c65179a532
status: 0
examples:
success:
value:
updated_at: 1622818516
meta: '{"full_name":"User"}'
created_at: 1622818473
email: user@example.com
consumer:
id: 06e5ea74-211e-4454-92cb-3f99bce4db10
id: 7581dec6-3f16-4509-86ef-b5c65179a532
status: 0
operationId: get-developer
description: Get the currently logged in developer's details
delete:
summary: Delete Developer
operationId: delete-developer
responses:
'204':
description: No Content
'401':
description: Unauthorized
content:
application/json:
schema:
description: ''
type: object
properties:
message:
type: string
minLength: 1
required:
- message
x-examples:
example-1:
message: Invalid authentication credentials
examples:
error:
value:
message: Invalid authentication credentials
description: Delete the current developer's account
tags:
- developer
/developer/meta_fields:
get:
summary: Your GET endpoint
tags:
- developer
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
description: ''
minItems: 1
uniqueItems: true
items:
type: object
required:
- title
- label
- is_email
- validator
properties:
title:
type: string
minLength: 1
label:
type: string
minLength: 1
is_email:
type: boolean
validator:
type: object
properties:
type:
type: string
minLength: 1
required:
type: boolean
required:
- type
- required
x-examples:
example-1:
- title: full_name
label: Full Name
is_email: false
validator:
type: string
required: true
examples:
success:
value:
- title: full_name
label: Full Name
is_email: false
validator:
type: string
required: true
operationId: get-developer-meta
description: Get metadata associated with the current user
/developer/password:
patch:
summary: Update Password
operationId: update-password
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
description: ''
type: object
properties:
message:
type: string
minLength: 1
required:
- message
x-examples:
example-1:
message: Old password is invalid
examples:
error:
value:
message: Old password is invalid
requestBody:
content:
application/x-www-form-urlencoded:
schema:
description: ''
type: object
properties:
password:
type: string
minLength: 1
old_password:
type: string
minLength: 1
required:
- password
- old_password
x-examples:
example-1:
password: password123
old_password: password
examples:
update-password:
value:
password: password
old_password: password123
tags:
- developer
description: Change the currently logged in user's password
/developer/email:
patch:
summary: Update Email
operationId: update-email
responses:
'200':
description: OK
requestBody:
content:
application/x-www-form-urlencoded:
schema:
description: ''
type: object
properties:
email:
type: string
minLength: 1
required:
- email
x-examples:
example-1:
email: user@example.com
examples:
update-email:
value:
email: user@example.com
tags:
- developer
description: Update the currently logged in user's email
/developer/meta:
patch:
summary: ''
operationId: update-meta
responses:
'200':
description: Metadata updated. This endpoint does not return a body
description: Update developer meta fields
requestBody:
content:
application/x-www-form-urlencoded:
schema:
description: ''
type: object
properties:
meta:
type: string
minLength: 1
required:
- meta
x-examples:
example-1:
meta: '{"full_name":"Bob"}'
examples:
update-meta:
value:
meta: '{"full_name":"Bob"}'
tags:
- developer
/credentials/key-auth:
get:
summary: Get Credentials (Key Auth)
tags:
- credentials
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
properties:
next: {}
data:
type: array
uniqueItems: true
minItems: 1
items:
required:
- created_at
- key
- id
properties:
consumer:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
created_at:
type: number
key:
type: string
minLength: 1
id:
type: string
minLength: 1
total:
type: number
required:
- data
- total
x-examples:
example-1:
next: null
data:
- consumer:
id: 52b6eefa-1962-42b1-a5c7-26370c5427c5
created_at: 1621616464
key: demo123
id: 567276e0-2b15-4592-b9d4-c40f5439873f
total: 1
examples:
success:
value:
data:
- key: demo123
consumer:
id: 797625f9-5bff-4270-8857-ca4e9c192f17
id: 4d00b0be-651e-468d-baba-12f5ca6988b5
created_at: 1622826008
next: null
total: 1
operationId: get-credentials-key-auth
description: List available key-auth credentials
post:
summary: Create Credential (key-auth)
operationId: create-credentials-key-auth
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
properties:
key:
type: string
minLength: 1
consumer:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
id:
type: string
minLength: 1
created_at:
type: number
required:
- key
- consumer
- id
- created_at
x-examples:
example-1:
key: demo123
consumer:
id: 797625f9-5bff-4270-8857-ca4e9c192f17
id: 4d00b0be-651e-468d-baba-12f5ca6988b5
created_at: 1622826008
examples:
success:
value:
key: demo123
consumer:
id: 797625f9-5bff-4270-8857-ca4e9c192f17
id: 4d00b0be-651e-468d-baba-12f5ca6988b5
created_at: 1622826008
description: Create key-auth credentials
requestBody:
content:
application/x-www-form-urlencoded:
schema:
description: ''
type: object
x-examples:
example-1:
key: demo123
properties:
key:
type: string
minLength: 1
examples:
create:
value:
key: demo123
tags:
- credentials
/credentials/jwt:
get:
summary: Get Credentials (JWT)
tags:
- credentials
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
anyOf:
- $ref: '#/components/schemas/JWTHS'
- $ref: '#/components/schemas/JWTRS'
examples:
success:
value:
data:
- algorithm: HS256
id: 4802966c-38fb-44f6-b31b-9c39ea688c99
created_at: 1622826359
secret: secret1
consumer:
id: 797625f9-5bff-4270-8857-ca4e9c192f17
key: demo123
- algorithm: RS256
id: b6559540-f68d-4ecb-9791-f5668f92dd9e
created_at: 1622826371
secret: secret1
consumer:
id: 797625f9-5bff-4270-8857-ca4e9c192f17
rsa_public_key: |-
-----BEGIN PUBLIC KEY-----
MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAtZGewwUOx8dRq7txWGVt
FBd/s3RNcRDe8uNRM//LxNoMFlK+LCT3r8sUp7x5JQ9ee+rLVV5YpUWHYhQ0XtBP
FritRKabw/6cid+cBdeIQZ/BufVhxDybwm+Bq0CL+dHkXR1nLUoG6I1/CvSSjMVj
ILtsBDUC9B8PVpjRo66U5vx0mBCtItx4bblcSrAVkUHRH3fx9bHNrqQhNx8wNf08
VHuiCGKM7fo4YdhUJtXSCh5CKafnxjGLUMPKum82l23vNkhrV7H7FjKv9OpWeIQt
xLq1gtUXLXUy0hM/WqtXDLzq3b3iXLHpilrPAUsaBGDvaO9qnqfJ7/kLJXz4Zxn8
V70ucfMABJc5lAiEZpBVtSJ5QTIurdIvAIBuCU7VS3wHwPtNwKIdLQVNLqUYsSGl
yp5zfAhKjrdmKCNUgdIMmFiCB1UqfTWESw7OT7kfu4xc15QIZc+JJD24QwUSJLwl
OgHDzFigMcPuLYpmswPEIYjOcZefe8PreZcVzDSBQkMDS8TP9MUYpd225AtyVChB
xUxLZ8Ca4C1pWI/Jlh9E5ZRk1dnvgypcipkSzj24uTazZQUws0qbCE0ZaEd0yxYz
1MIQaWMQ/hk38h4ogkdatTXjalFIHJ+Vrt7nkfcOzD2/ujBacMvr/9WB1xcBNEUg
ZRP0UdnTaVZ5EqWVwqNTUvcCAwEAAQ==
-----END PUBLIC KEY-----
key: demo999
next: null
total: 2
operationId: get-credentials-jwt
description: List available JWT credentials
post:
summary: Create Credential (JWT)
operationId: create-credential-jwt
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties: {}
requestBody:
content:
application/x-www-form-urlencoded:
schema:
description: ''
type: object
x-examples:
example-1:
key: demo123
secret: secret1
algorithm: HS256
properties:
key:
type: string
minLength: 1
secret:
type: string
minLength: 1
algorithm:
type: string
minLength: 1
rsa_public_key:
type: string
'':
type: string
required:
- key
- secret
- algorithm
examples:
HS256:
value:
key: hs-key
secret: secret1
algorithm: HS256
RS256:
value:
key: rs-key
secret: secret1
algorithm: RS256
rsa_public_key: |-
-----BEGIN PUBLIC KEY-----
MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAtZGewwUOx8dRq7txWGVt
FBd/s3RNcRDe8uNRM//LxNoMFlK+LCT3r8sUp7x5JQ9ee+rLVV5YpUWHYhQ0XtBP
FritRKabw/6cid+cBdeIQZ/BufVhxDybwm+Bq0CL+dHkXR1nLUoG6I1/CvSSjMVj
ILtsBDUC9B8PVpjRo66U5vx0mBCtItx4bblcSrAVkUHRH3fx9bHNrqQhNx8wNf08
VHuiCGKM7fo4YdhUJtXSCh5CKafnxjGLUMPKum82l23vNkhrV7H7FjKv9OpWeIQt
xLq1gtUXLXUy0hM/WqtXDLzq3b3iXLHpilrPAUsaBGDvaO9qnqfJ7/kLJXz4Zxn8
V70ucfMABJc5lAiEZpBVtSJ5QTIurdIvAIBuCU7VS3wHwPtNwKIdLQVNLqUYsSGl
yp5zfAhKjrdmKCNUgdIMmFiCB1UqfTWESw7OT7kfu4xc15QIZc+JJD24QwUSJLwl
OgHDzFigMcPuLYpmswPEIYjOcZefe8PreZcVzDSBQkMDS8TP9MUYpd225AtyVChB
xUxLZ8Ca4C1pWI/Jlh9E5ZRk1dnvgypcipkSzj24uTazZQUws0qbCE0ZaEd0yxYz
1MIQaWMQ/hk38h4ogkdatTXjalFIHJ+Vrt7nkfcOzD2/ujBacMvr/9WB1xcBNEUg
ZRP0UdnTaVZ5EqWVwqNTUvcCAwEAAQ==
-----END PUBLIC KEY-----
description: Create a new JWT credential
tags:
- credentials
parameters: []
/credentials/jwt/{id}:
get:
summary: Get Credential (JWT)
tags:
- credentials
operationId: get-credential-jwt
description: Get JWT Credential
responses:
'200':
description: OK
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/JWTHS'
- $ref: '#/components/schemas/JWTRS'
parameters: []
patch:
summary: Update Credential (JWT)
operationId: patch-credential-jwt
responses:
'200':
description: OK
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/JWTHS'
- $ref: '#/components/schemas/JWTRS'
examples:
success:
value:
algorithm: HS256
id: 4802966c-38fb-44f6-b31b-9c39ea688c99
created_at: 1622826359
secret: secret2
consumer:
id: 797625f9-5bff-4270-8857-ca4e9c192f17
key: demo1234
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/JWT'
description: Update an existing JWT credential
tags:
- credentials
parameters:
- schema:
type: string
name: id
in: path
required: true
delete:
summary: Delete Credential (JWT)
operationId: delete-credential-jwt
responses:
'204':
description: No Content
description: Delete an existing JWT credential
tags:
- credentials
/applications:
get:
summary: List applications
tags:
- application
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
properties:
data:
type: array
uniqueItems: true
minItems: 1
items:
required:
- created_at
- id
- redirect_uri
- updated_at
- name
properties:
created_at:
type: number
id:
type: string
minLength: 1
redirect_uri:
type: string
minLength: 1
updated_at:
type: number
developer:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
name:
type: string
minLength: 1
consumer:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
next: {}
total:
type: number
required:
- data
- total
x-examples:
example-1:
data:
- created_at: 1626966853
id: 3c929386-bd89-4c55-92b5-b4966f7957ab
redirect_uri: https://example.com
updated_at: 1626966853
developer:
id: 7bd5256c-00e0-47c5-86a7-949aef632a21
name: Demo
consumer:
id: b9b6a89d-3fb3-483a-a2df-0bdf4d7d26fe
next: null
total: 1
examples:
success:
value:
data:
- created_at: 1626966853
id: 3c929386-bd89-4c55-92b5-b4966f7957ab
redirect_uri: https://example.com
updated_at: 1626966853
developer:
id: 7bd5256c-00e0-47c5-86a7-949aef632a21
name: Demo
consumer:
id: b9b6a89d-3fb3-483a-a2df-0bdf4d7d26fe
next: null
total: 1
operationId: list-applications
description: List applications
post:
summary: Create Application
operationId: post-applications
responses:
'201':
description: Created
content:
application/json:
schema:
description: ''
type: object
properties:
created_at:
type: number
id:
type: string
minLength: 1
redirect_uri:
type: string
minLength: 1
updated_at:
type: number
developer:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
name:
type: string
minLength: 1
consumer:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
required:
- created_at
- id
- redirect_uri
- updated_at
- developer
- name
- consumer
x-examples:
example-1:
created_at: 1626967086
id: fa18fdb0-8cc3-4356-95e5-813ca6bf21de
redirect_uri: http://localhost
updated_at: 1626967086
developer:
id: 7bd5256c-00e0-47c5-86a7-949aef632a21
name: My Application
consumer:
id: 051d9ad2-0fc6-41a6-9bf3-4132117d980e
tags:
- application
description: Create an application
requestBody:
content:
application/x-www-form-urlencoded:
schema:
description: ''
type: object
properties:
redirect_uri:
type: string
minLength: 1
name:
type: string
minLength: 1
required:
- redirect_uri
- name
x-examples:
example-1:
redirect_uri: http://localhost
name: My Application
examples:
create:
value:
redirect_uri: string
name: string
/applications/{id}:
get:
summary: Get Application
tags:
- application
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
properties:
data:
type: array
uniqueItems: true
minItems: 1
items:
required:
- created_at
- id
- redirect_uri
- updated_at
- name
properties:
created_at:
type: number
id:
type: string
minLength: 1
redirect_uri:
type: string
minLength: 1
updated_at:
type: number
developer:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
name:
type: string
minLength: 1
consumer:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
next: {}
total:
type: number
required:
- data
- total
x-examples:
example-1:
data:
- created_at: 1626966853
id: 3c929386-bd89-4c55-92b5-b4966f7957ab
redirect_uri: https://example.com
updated_at: 1626966853
developer:
id: 7bd5256c-00e0-47c5-86a7-949aef632a21
name: Demo
consumer:
id: b9b6a89d-3fb3-483a-a2df-0bdf4d7d26fe
next: null
total: 1
examples:
application:
value:
created_at: 1626967086
id: fa18fdb0-8cc3-4356-95e5-813ca6bf21de
redirect_uri: http://localhost
updated_at: 1626967086
developer:
id: 7bd5256c-00e0-47c5-86a7-949aef632a21
name: My Application
consumer:
id: 051d9ad2-0fc6-41a6-9bf3-4132117d980e
operationId: get-application
description: Get application
parameters:
- schema:
type: string
name: id
in: path
required: true
description: Application ID
patch:
summary: Update Application
operationId: update-application
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
properties:
created_at:
type: number
id:
type: string
minLength: 1
redirect_uri:
type: string
minLength: 1
updated_at:
type: number
developer:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
name:
type: string
minLength: 1
consumer:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
required:
- created_at
- id
- redirect_uri
- updated_at
- developer
- name
- consumer
x-examples:
example-1:
created_at: 1626967086
id: fa18fdb0-8cc3-4356-95e5-813ca6bf21de
redirect_uri: http://localhost
updated_at: 1626967282
developer:
id: 7bd5256c-00e0-47c5-86a7-949aef632a21
name: Another
consumer:
id: 051d9ad2-0fc6-41a6-9bf3-4132117d980e
examples:
updated:
value:
created_at: 0
id: string
redirect_uri: string
updated_at: 0
developer:
id: string
name: string
consumer:
id: string
description: Update application
tags:
- application
requestBody:
content:
application/x-www-form-urlencoded:
schema:
description: ''
type: object
x-examples:
example-1:
name: Another
properties:
name:
type: string
minLength: 1
request_uri:
type: string
required:
- name
examples:
update:
value:
redirect_uri: string
name: string
delete:
summary: Delete Application
operationId: delete-application
responses:
'204':
description: No Content
tags:
- application
description: Delete application
/application_services:
get:
summary: List Application Services
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
properties:
data:
type: array
uniqueItems: true
minItems: 1
items:
required:
- name
- id
properties:
name:
type: string
minLength: 1
app_registration_config:
type: object
properties:
description:
type: string
minLength: 1
show_issuer:
type: boolean
display_name:
type: string
minLength: 1
auto_approve:
type: boolean
required:
- description
- show_issuer
- display_name
- auto_approve
id:
type: string
minLength: 1
next: {}
total:
type: number
required:
- data
- total
x-examples:
example-1:
data:
- name: Demo Name
app_registration_config:
description: Demo Description
show_issuer: false
display_name: Demo Name
auto_approve: false
id: d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad
next: null
total: 1
examples:
pending:
value:
data:
- name: Demo Name
app_registration_config:
description: Demo Description
show_issuer: false
display_name: Demo App
auto_approve: false
id: d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad
next: null
total: 1
operationId: get-application_services
description: List available services
tags:
- application-services
/applications/{id}/application_instances:
get:
summary: List Application Services
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
properties:
data:
type: array
uniqueItems: true
minItems: 1
items:
required:
- name
- id
properties:
name:
type: string
minLength: 1
app_registration_config:
type: object
properties:
description:
type: string
minLength: 1
show_issuer:
type: boolean
display_name:
type: string
minLength: 1
auto_approve:
type: boolean
required:
- description
- show_issuer
- display_name
- auto_approve
id:
type: string
minLength: 1
next: {}
total:
type: number
required:
- data
- total
x-examples:
example-1:
data:
- name: Demo Name
app_registration_config:
description: Demo Description
show_issuer: false
display_name: Demo Name
auto_approve: false
id: d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad
next: null
total: 1
examples:
pending:
value:
data:
- name: Demo Name
app_registration_config:
description: Demo Description
show_issuer: false
display_name: Demo App
auto_approve: false
id: d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad
next: null
total: 1
operationId: list-application-services
description: List application services
tags:
- application-instances
parameters:
- schema:
type: string
name: id
in: path
required: true
post:
summary: Create Application Instance
operationId: create-application-instance
responses:
'201':
description: Created
content:
application/json:
schema:
description: ''
type: object
properties:
created_at:
type: number
suspended:
type: boolean
status:
type: number
id:
type: string
minLength: 1
composite_id:
type: string
minLength: 1
updated_at:
type: number
application:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
service:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
required:
- created_at
- suspended
- status
- id
- composite_id
- updated_at
- application
- service
x-examples:
example-1:
created_at: 1626968283
suspended: false
status: 1
id: 9968b0d6-7358-4989-b359-e1ab913753f7
composite_id: 3c929386-bd89-4c55-92b5-b4966f7957ab_d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad
updated_at: 1626968283
application:
id: 3c929386-bd89-4c55-92b5-b4966f7957ab
service:
id: d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad
examples:
success:
value:
created_at: 1626968283
suspended: false
status: 1
id: 9968b0d6-7358-4989-b359-e1ab913753f7
composite_id: 3c929386-bd89-4c55-92b5-b4966f7957ab_d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad
updated_at: 1626968283
application:
id: 3c929386-bd89-4c55-92b5-b4966f7957ab
service:
id: d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad
description: Create Application Instance
requestBody:
content:
application/x-www-form-urlencoded:
schema:
description: ''
type: object
properties:
service.id:
type: string
minLength: 1
required:
- service.id
x-examples:
example-1:
service.id: d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad
examples:
create:
value:
service.id: d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad
tags:
- application-instances
/applications/{id}/application_instances/{instance}:
get:
summary: Get Application Instance
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
properties:
created_at:
type: number
suspended:
type: boolean
status:
type: number
id:
type: string
minLength: 1
composite_id:
type: string
minLength: 1
updated_at:
type: number
application:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
service:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
required:
- created_at
- suspended
- status
- id
- composite_id
- updated_at
- application
- service
x-examples:
example-1:
created_at: 1626967481
suspended: false
status: 0
id: 724e758a-0633-4ecc-ab92-8727c42820e7
composite_id: 3c929386-bd89-4c55-92b5-b4966f7957ab_d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad
updated_at: 1626967581
application:
id: 3c929386-bd89-4c55-92b5-b4966f7957ab
service:
id: d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad
examples:
pending:
value:
data:
- name: Demo Name
app_registration_config:
description: Demo Description
show_issuer: false
display_name: Demo App
auto_approve: false
id: d2b5a2c9-51a2-45f9-a62b-17cb5e8ce2ad
next: null
total: 1
operationId: get-application-instance
description: Get an application instance
tags:
- application-instances
parameters:
- schema:
type: string
name: id
in: path
required: true
- schema:
type: string
name: instance
in: path
required: true
delete:
summary: Delete Application Instance
operationId: delete-application-instance
responses:
'204':
description: No Content
description: Delete application instance
tags:
- application-instances
/applications/{id}/credentials:
parameters:
- schema:
type: string
name: id
in: path
required: true
get:
summary: List Application Credentials
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
properties:
data:
type: array
uniqueItems: true
minItems: 1
items:
required:
- created_at
- id
- client_type
- name
- hash_secret
- client_id
- client_secret
properties:
consumer:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
created_at:
type: number
id:
type: string
minLength: 1
client_type:
type: string
minLength: 1
name:
type: string
minLength: 1
hash_secret:
type: boolean
client_id:
type: string
minLength: 1
client_secret:
type: string
minLength: 1
redirect_uris:
type: array
items:
required: []
properties: {}
next: {}
total:
type: number
required:
- data
- total
x-examples:
example-1:
data:
- consumer:
id: b9b6a89d-3fb3-483a-a2df-0bdf4d7d26fe
created_at: 1626967455
id: 40cc2b81-e92e-4208-8859-83a58bad6136
client_type: confidential
name: Demo
hash_secret: false
client_id: CqXDjc0UTN5mjHwh38yTU6a8yMeAG3S7
client_secret: KxKCqk0a097i2cXfe46iVVAyTY2r7KCC
redirect_uris:
- https://example.com
next: null
total: 1
examples:
credentials:
value:
data:
- consumer:
id: string
created_at: 0
id: string
client_type: string
name: string
hash_secret: true
client_id: string
client_secret: string
redirect_uris:
- {}
next: null
total: 0
operationId: list-application-credentials
description: List Application Credentials
tags:
- application-credentials
post:
summary: Create application credentials
operationId: create-application-credentials
responses:
'201':
description: Created
content:
application/json:
schema:
description: ''
type: object
properties:
consumer:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
created_at:
type: number
id:
type: string
minLength: 1
client_type:
type: string
minLength: 1
name:
type: string
minLength: 1
hash_secret:
type: boolean
client_id:
type: string
minLength: 1
client_secret:
type: string
minLength: 1
redirect_uris:
type: array
items:
required: []
properties: {}
required:
- consumer
- created_at
- id
- client_type
- name
- hash_secret
- client_id
- client_secret
- redirect_uris
x-examples:
example-1:
consumer:
id: b9b6a89d-3fb3-483a-a2df-0bdf4d7d26fe
created_at: 1626968440
id: fb1ea628-1adc-4d67-b86e-395e7a12d689
client_type: confidential
name: Demo
hash_secret: false
client_id: uleOEF5HkPrq2aogk5Y0f2yfB8qmX6xZ
client_secret: I8hoJyPSO6WAFmwv7giaUbwtZPmIy7Uo
redirect_uris:
- https://example.com
examples:
success:
value:
consumer:
id: b9b6a89d-3fb3-483a-a2df-0bdf4d7d26fe
created_at: 1626968440
id: fb1ea628-1adc-4d67-b86e-395e7a12d689
client_type: confidential
name: Demo
hash_secret: false
client_id: uleOEF5HkPrq2aogk5Y0f2yfB8qmX6xZ
client_secret: I8hoJyPSO6WAFmwv7giaUbwtZPmIy7Uo
redirect_uris:
- https://example.com
description: Create application credentials
tags:
- application-credentials
/applications/{id}/credentials/{credential}:
parameters:
- schema:
type: string
name: id
in: path
required: true
- schema:
type: string
name: credential
in: path
required: true
get:
summary: Get Application Credentials
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
properties:
data:
type: array
uniqueItems: true
minItems: 1
items:
required:
- created_at
- id
- client_type
- name
- hash_secret
- client_id
- client_secret
properties:
consumer:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
created_at:
type: number
id:
type: string
minLength: 1
client_type:
type: string
minLength: 1
name:
type: string
minLength: 1
hash_secret:
type: boolean
client_id:
type: string
minLength: 1
client_secret:
type: string
minLength: 1
redirect_uris:
type: array
items:
required: []
properties: {}
next: {}
total:
type: number
required:
- data
- total
x-examples:
example-1:
data:
- consumer:
id: b9b6a89d-3fb3-483a-a2df-0bdf4d7d26fe
created_at: 1626967455
id: 40cc2b81-e92e-4208-8859-83a58bad6136
client_type: confidential
name: Demo
hash_secret: false
client_id: CqXDjc0UTN5mjHwh38yTU6a8yMeAG3S7
client_secret: KxKCqk0a097i2cXfe46iVVAyTY2r7KCC
redirect_uris:
- https://example.com
next: null
total: 1
examples:
credentials:
value:
data:
- consumer:
id: string
created_at: 0
id: string
client_type: string
name: string
hash_secret: true
client_id: string
client_secret: string
redirect_uris:
- {}
next: null
total: 0
operationId: get-application-credential
description: Get Application Credentials
tags:
- application-credentials
delete:
summary: Delete Application Credential
operationId: delete-application-credential
responses:
'204':
description: No Content
description: Delete Application Credential
tags:
- application-credentials
components:
securitySchemes:
DeveloperCredentials:
type: http
scheme: basic
responses:
TokenIsRequired:
description: Bad Request
content:
application/json:
schema:
description: ''
type: object
properties:
message:
type: string
minLength: 1
required:
- message
examples:
missing-token:
value:
message: token is required
schemas:
JWT:
title: JWT
description: ''
type: object
x-examples:
example-1:
key: demo123
secret: secret1
algorithm: HS256
properties:
key:
type: string
minLength: 1
secret:
type: string
minLength: 1
algorithm:
type: string
minLength: 1
rsa_public_key:
type: string
'':
type: string
required:
- key
- secret
- algorithm
JWTHS:
description: ''
type: object
properties:
algorithm:
type: string
minLength: 1
id:
type: string
minLength: 1
created_at:
type: number
secret:
type: string
minLength: 1
consumer:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
key:
type: string
minLength: 1
required:
- algorithm
- id
- created_at
- secret
- consumer
- key
JWTRS:
description: ''
type: object
properties:
algorithm:
type: string
minLength: 1
id:
type: string
minLength: 1
created_at:
type: number
secret:
type: string
minLength: 1
consumer:
type: object
properties:
id:
type: string
minLength: 1
required:
- id
rsa_public_key:
type: string
minLength: 1
key:
type: string
minLength: 1
required:
- algorithm
- id
- created_at
- secret
- consumer
- rsa_public_key
- key
tags:
- name: account
- name: application
- name: application-instances
- name: application-credentials
- name: application-services
- name: authentication
- name: configuration
- name: credentials
- name: developer
- name: files
- name: vitals