Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: P4ADEV-523 exposing operatorList API #45

Merged
merged 1 commit into from
Jul 2, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 104 additions & 0 deletions openapi/p4pa-auth.openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,46 @@ paths:
description: Invalid request
'401':
description: Invalid client_id
/am/operators/{organizationIpaCode}:
get:
tags:
- authz
operationId: getOrganizationOperators
parameters:
- name: organizationIpaCode
in: path
required: true
schema:
type: string
- name: page
in: query
description: "The number of the page"
schema:
type: integer
default: 0
- name: size
in: query
description: "Number of items"
schema:
type: integer
default: 10
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/OperatorsPage'
'400':
description: Invalid request
'401':
description: Unauthorized
'403':
description: Forbidden
'412':
description: ToS acceptance missing
'429':
description: Too Many Requests
security:
- BearerAuth: []
components:
Expand Down Expand Up @@ -192,6 +232,70 @@ components:
type: array
items:
type: string
OperatorsPage:
type: object
required:
- content
- pageNo
- pageSize
- totalElements
- totalPages
properties:
content:
type: array
items:
$ref: '#/components/schemas/Operator'
description: "The list of organization operators"
pageNo:
type: integer
format: int32
description: "Number of page"
pageSize:
type: integer
format: int32
description: "Number of elements in the page"
totalElements:
type: integer
format: int32
description: "Number of total elements"
totalPages:
type: integer
format: int32
description: "Number of total pages"
Operator:
type: object
required:
- userId
- mappedExternalUserId
- userCode
- operatorId
- roles
- organizationIpaCode
properties:
userId:
type: integer
format: int32
mappedExternalUserId:
type: string
userCode:
type: string
operatorId:
type: integer
format: int32
roles:
type: array
items:
type: string
organizationIpaCode:
type: string
fiscalCode:
type: string
name:
type: string
familyName:
type: string
email:
type: string
AuthErrorDTO:
type: object
required:
Expand Down