mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 04:19:16 +00:00
9269e86172
* added new oauth2 flow and description * renamed authentication to make more sense' by github action: 5967546682
91 lines
2.4 KiB
YAML
91 lines
2.4 KiB
YAML
get:
|
|
tags:
|
|
- Sources
|
|
summary: Downloads source accounts schema template
|
|
description: >-
|
|
This API downloads the CSV schema that defines the account attributes on a source.
|
|
|
|
>**NOTE: This API is designated only for Delimited File sources.**
|
|
operationId: getAccountsSchema
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The Source id
|
|
example: '8c190e6787aa4ed9a90bd9d5344523fb'
|
|
responses:
|
|
'200':
|
|
description: Successfully downloaded the file
|
|
content:
|
|
text/csv:
|
|
example: "id,name,givenName,familyName,e-mail,location,manager,groups,startDate,endDate"
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'404':
|
|
$ref: '../../v3/responses/404.yaml'
|
|
'429':
|
|
$ref: '../../v3/responses/429.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|
|
security:
|
|
- UserContextAuth: [idn:source-schema:read]
|
|
post:
|
|
tags:
|
|
- Sources
|
|
summary: Uploads source accounts schema template
|
|
description: >-
|
|
This API uploads a source schema template file to configure a source's account attributes.
|
|
|
|
|
|
To retrieve the file to modify and upload, log into Identity Now.
|
|
|
|
|
|
Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema**
|
|
|
|
|
|
>**NOTE: This API is designated only for Delimited File sources.**
|
|
operationId: importAccountsSchema
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
required: true
|
|
schema:
|
|
type: string
|
|
description: The Source id
|
|
example: '8c190e6787aa4ed9a90bd9d5344523fb'
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
multipart/form-data:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
file:
|
|
type: string
|
|
format: binary
|
|
responses:
|
|
'200':
|
|
description: Successfully uploaded the file
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/Schema.yaml'
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'429':
|
|
$ref: '../../v3/responses/429.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|
|
security:
|
|
- UserContextAuth: [idn:source-schema:manage]
|