Files
directus/packages/spec/specs/paths/scim/groups.yaml
2020-09-14 20:01:01 +02:00

58 lines
1.5 KiB
YAML

get:
description: List the SCIM Groups.
operationId: getSCIMGroups
parameters:
- description: The 1-based index of the first result in the current set of list results.
in: query
name: startIndex
required: false
schema:
type: integer
- description: Specifies the desired maximum number of query results per page.
in: query
name: count
required: false
schema:
type: integer
- description: Filter by `id`, `userName`, `emails.value` and `externalId` attributes
are supported. Only the `eq` operator is supported. Uses format `?filter=id eq
15`
in: query
name: filter
required: false
schema:
type: integer
responses:
'200':
description: Successful request
content:
application/json:
schema:
type: object
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
'404':
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
tags:
- SCIM
post:
description: Create a new SCIM Group.
operationId: createSCIMGroup
requestBody:
content:
application/json:
schema:
type: object
responses:
'200':
description: Successful request
content:
application/json:
schema:
type: object
'401':
$ref: '../../openapi.yaml#/components/responses/UnauthorizedError'
'404':
$ref: '../../openapi.yaml#/components/responses/NotFoundError'
tags:
- SCIM