mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-10 04:19:19 +00:00
Automated commit by github action: 3566229104
This commit is contained in:
@@ -10,7 +10,8 @@ get:
|
|||||||
|
|
||||||
Request will require the following security scope:
|
Request will require the following security scope:
|
||||||
|
|
||||||
- 'idn:oathkeeper-client:read'
|
- sp:oauth-client:manage
|
||||||
|
- sp:oauth-client:read
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
name: id
|
name: id
|
||||||
@@ -50,8 +51,7 @@ delete:
|
|||||||
|
|
||||||
Request will require the following security scopes:
|
Request will require the following security scopes:
|
||||||
|
|
||||||
- 'idn:oathkeeper-client:delete'
|
- sp:oauth-client:manage
|
||||||
- 'idn:oathkeeper-internal-client:delete'
|
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
name: id
|
name: id
|
||||||
@@ -87,7 +87,7 @@ patch:
|
|||||||
|
|
||||||
Request will require a security scope of
|
Request will require a security scope of
|
||||||
|
|
||||||
'idn:oathkeeper-client:update'
|
- sp:oauth-client:manage
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
name: id
|
name: id
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ get:
|
|||||||
|
|
||||||
Request will require the following security scope:
|
Request will require the following security scope:
|
||||||
|
|
||||||
- 'idn:oathkeeper-client-list:read'
|
- sp:oauth-client:manage
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: List of OAuth clients.
|
description: List of OAuth clients.
|
||||||
@@ -42,8 +42,7 @@ post:
|
|||||||
|
|
||||||
Request will require the following security scope:
|
Request will require the following security scope:
|
||||||
|
|
||||||
- 'idn:oathkeeper-client:create'
|
- sp:oauth-client:manage
|
||||||
- 'idn:oathkeeper-internal-client:create'
|
|
||||||
requestBody:
|
requestBody:
|
||||||
required: true
|
required: true
|
||||||
content:
|
content:
|
||||||
|
|||||||
@@ -6,11 +6,10 @@ delete:
|
|||||||
description: >-
|
description: >-
|
||||||
This deletes a personal access token
|
This deletes a personal access token
|
||||||
|
|
||||||
Any of the following rights are required to access this resource:
|
Request will require one of the following security scopes:
|
||||||
|
|
||||||
- idn:my-personal-access-tokens:delete
|
- sp:my-personal-access-tokens:manage
|
||||||
- idn:all-personal-access-tokens:delete
|
- sp:all-personal-access-tokens:manage
|
||||||
- idn:managed-personal-access-tokens:delete
|
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
|
|||||||
@@ -8,11 +8,12 @@ get:
|
|||||||
query parameter. If the `owner-id` query parameter is omitted, all personal access tokens
|
query parameter. If the `owner-id` query parameter is omitted, all personal access tokens
|
||||||
for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right.
|
for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right.
|
||||||
|
|
||||||
Any of the following rights are required to access this resource:
|
Request will require one of the following security scopes:
|
||||||
|
|
||||||
- idn:my-personal-access-tokens:read
|
- sp:my-personal-access-tokens:read
|
||||||
- idn:all-personal-access-tokens:read
|
- sp:my-personal-access-tokens:manage
|
||||||
- idn:managed-personal-access-tokens:read
|
- sp:all-personal-access-tokens:read
|
||||||
|
- sp:all-personal-access-tokens:manage
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
- in: query
|
- in: query
|
||||||
@@ -58,11 +59,10 @@ post:
|
|||||||
description: >-
|
description: >-
|
||||||
This creates a personal access token.
|
This creates a personal access token.
|
||||||
|
|
||||||
Any of the following rights are required to access this resource:
|
Request will require one of the following security scopes:
|
||||||
|
|
||||||
- idn:my-personal-access-tokens:create
|
- sp:my-personal-access-tokens:manage
|
||||||
- idn:all-personal-access-tokens:create
|
- sp:all-personal-access-tokens:manage
|
||||||
- idn:managed-personal-access-tokens:create
|
|
||||||
|
|
||||||
requestBody:
|
requestBody:
|
||||||
description: Name and scope of personal access token.
|
description: Name and scope of personal access token.
|
||||||
|
|||||||
@@ -8,9 +8,10 @@ get:
|
|||||||
description: >-
|
description: >-
|
||||||
This gets export file resulting from the export job with the requested id and downloads it to a file.
|
This gets export file resulting from the export job with the requested id and downloads it to a file.
|
||||||
|
|
||||||
Request will need the following security scope:
|
Request will need one of the following security scopes:
|
||||||
|
|
||||||
'sp:config:export'
|
- sp:config:read
|
||||||
|
- sp:config:manage
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
name: id
|
name: id
|
||||||
|
|||||||
@@ -8,9 +8,10 @@ get:
|
|||||||
description: >-
|
description: >-
|
||||||
This gets the status of the export job identified by the id parameter.
|
This gets the status of the export job identified by the id parameter.
|
||||||
|
|
||||||
Request will need the following security scope:
|
Request will need one of the following security scopes:
|
||||||
|
|
||||||
'sp:config:export'
|
- sp:config:read
|
||||||
|
- sp:config:manage
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
name: id
|
name: id
|
||||||
|
|||||||
@@ -8,9 +8,10 @@ post:
|
|||||||
description: >-
|
description: >-
|
||||||
This post will export objects from the tenant to a JSON configuration file.
|
This post will export objects from the tenant to a JSON configuration file.
|
||||||
|
|
||||||
Request will need the following security scope:
|
Request will need one of the following security scopes:
|
||||||
|
|
||||||
'sp:config:export'
|
- sp:config:read
|
||||||
|
- sp:config:manage
|
||||||
requestBody:
|
requestBody:
|
||||||
description: Export options control what will be included in the export.
|
description: Export options control what will be included in the export.
|
||||||
required: true
|
required: true
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ get:
|
|||||||
|
|
||||||
Request will need the following security scope:
|
Request will need the following security scope:
|
||||||
|
|
||||||
'sp:config:import'
|
- sp:config:manage
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
name: id
|
name: id
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ get:
|
|||||||
|
|
||||||
Request will need the following security scope:
|
Request will need the following security scope:
|
||||||
|
|
||||||
'sp:config:import'
|
- sp:config:manage
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
name: id
|
name: id
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ post:
|
|||||||
|
|
||||||
Request will need the following security scope:
|
Request will need the following security scope:
|
||||||
|
|
||||||
'sp:config:import'
|
- sp:config:manage
|
||||||
parameters:
|
parameters:
|
||||||
- in: query
|
- in: query
|
||||||
name: preview
|
name: preview
|
||||||
|
|||||||
@@ -9,9 +9,10 @@ get:
|
|||||||
This gets the list of object configurations which are known to the tenant export/import service.
|
This gets the list of object configurations which are known to the tenant export/import service.
|
||||||
Object configurations that contain "importUrl" and "exportUrl" are available for export/import.
|
Object configurations that contain "importUrl" and "exportUrl" are available for export/import.
|
||||||
|
|
||||||
Request will need the following security scope:
|
Request will need one of the following security scopes:
|
||||||
|
|
||||||
'sp:config:export'
|
- sp:config:read
|
||||||
|
- sp:config:manage
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@@ -49,6 +49,7 @@ properties:
|
|||||||
example: 10
|
example: 10
|
||||||
referenceExtractors:
|
referenceExtractors:
|
||||||
type: array
|
type: array
|
||||||
|
nullable: true
|
||||||
description: >-
|
description: >-
|
||||||
List of json paths within an exported object of this type that represent references that need to be resolved.
|
List of json paths within an exported object of this type that represent references that need to be resolved.
|
||||||
items:
|
items:
|
||||||
|
|||||||
@@ -10,7 +10,8 @@ get:
|
|||||||
|
|
||||||
Request will require the following security scope:
|
Request will require the following security scope:
|
||||||
|
|
||||||
- 'idn:oathkeeper-client:read'
|
- sp:oauth-client:manage
|
||||||
|
- sp:oauth-client:read
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
name: id
|
name: id
|
||||||
@@ -50,8 +51,7 @@ delete:
|
|||||||
|
|
||||||
Request will require the following security scopes:
|
Request will require the following security scopes:
|
||||||
|
|
||||||
- 'idn:oathkeeper-client:delete'
|
- sp:oauth-client:manage
|
||||||
- 'idn:oathkeeper-internal-client:delete'
|
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
name: id
|
name: id
|
||||||
@@ -87,7 +87,7 @@ patch:
|
|||||||
|
|
||||||
Request will require a security scope of
|
Request will require a security scope of
|
||||||
|
|
||||||
'idn:oathkeeper-client:update'
|
- sp:oauth-client:manage
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
name: id
|
name: id
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ get:
|
|||||||
|
|
||||||
Request will require the following security scope:
|
Request will require the following security scope:
|
||||||
|
|
||||||
- 'idn:oathkeeper-client-list:read'
|
- sp:oauth-client:manage
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: List of OAuth clients.
|
description: List of OAuth clients.
|
||||||
@@ -42,8 +42,8 @@ post:
|
|||||||
|
|
||||||
Request will require the following security scope:
|
Request will require the following security scope:
|
||||||
|
|
||||||
- 'idn:oathkeeper-client:create'
|
- sp:oauth-client:manage
|
||||||
- 'idn:oathkeeper-internal-client:create'
|
|
||||||
requestBody:
|
requestBody:
|
||||||
required: true
|
required: true
|
||||||
content:
|
content:
|
||||||
|
|||||||
@@ -6,11 +6,10 @@ delete:
|
|||||||
description: >-
|
description: >-
|
||||||
This deletes a personal access token
|
This deletes a personal access token
|
||||||
|
|
||||||
Any of the following rights are required to access this resource:
|
Request will require one of the following security scopes:
|
||||||
|
|
||||||
- idn:my-personal-access-tokens:delete
|
- sp:my-personal-access-tokens:manage
|
||||||
- idn:all-personal-access-tokens:delete
|
- sp:all-personal-access-tokens:manage
|
||||||
- idn:managed-personal-access-tokens:delete
|
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
|
|||||||
@@ -8,11 +8,12 @@ get:
|
|||||||
query parameter. If the `owner-id` query parameter is omitted, all personal access tokens
|
query parameter. If the `owner-id` query parameter is omitted, all personal access tokens
|
||||||
for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right.
|
for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right.
|
||||||
|
|
||||||
Any of the following rights are required to access this resource:
|
Request will require one of the following security scopes:
|
||||||
|
|
||||||
- idn:my-personal-access-tokens:read
|
- sp:my-personal-access-tokens:read
|
||||||
- idn:all-personal-access-tokens:read
|
- sp:my-personal-access-tokens:manage
|
||||||
- idn:managed-personal-access-tokens:read
|
- sp:all-personal-access-tokens:read
|
||||||
|
- sp:all-personal-access-tokens:manage
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
- in: query
|
- in: query
|
||||||
@@ -58,11 +59,10 @@ post:
|
|||||||
description: >-
|
description: >-
|
||||||
This creates a personal access token.
|
This creates a personal access token.
|
||||||
|
|
||||||
Any of the following rights are required to access this resource:
|
Request will require one of the following security scopes:
|
||||||
|
|
||||||
- idn:my-personal-access-tokens:create
|
- sp:my-personal-access-tokens:manage
|
||||||
- idn:all-personal-access-tokens:create
|
- sp:all-personal-access-tokens:manage
|
||||||
- idn:managed-personal-access-tokens:create
|
|
||||||
|
|
||||||
requestBody:
|
requestBody:
|
||||||
description: Name and scope of personal access token.
|
description: Name and scope of personal access token.
|
||||||
|
|||||||
Reference in New Issue
Block a user