mod-users/ramls/userTenants.raml at master · folio-org/mod-users · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
#%RAML 1.0
title: User tenants
baseUri: http://github.com/org/folio/mod-users

documentation:
  - title: mod-users User tenants API
    content: Records that show the primary tenant for a user when doing single-sign-on

types:
  userTenant: !include userTenant.json
  userTenantCollection: !include userTenantCollection.json
  errors: !include raml-util/schemas/errors.schema

traits:
  pageable: !include raml-util/traits/pageable.raml
  validate: !include raml-util/traits/validation.raml

resourceTypes:
  collection: !include raml-util/rtypes/collection.raml
  collection-item: !include raml-util/rtypes/item-collection.raml

/user-tenants:
  type:
    collection:
      exampleCollection: !include examples/userTenantCollection.sample
      exampleItem: !include examples/userTenant.sample
      schemaCollection: userTenantCollection
      schemaItem: userTenant
  get:
    is: [
      pageable
    ]
    description: Return a list of user tenants
    queryParameters:
      userId:
        description: Filter by user id
        type: string
        example: 11484f66-5121-43ea-81e7-6d9e3711495f
        required: false
      username:
        description: Filter by user name
        type: string
        example: folio_user
        required: false
      tenantId:
        description: Filter by tenant id
        type: string
        example: sfs000
        required: false
      email:
        description: Filter by email
        type: string
        example: test@mail.com
        required: false
      phoneNumber:
        description: Filter by mobile number
        type: string
        example: "12345676"
        required: false
      mobilePhoneNumber:
        description: Filter by mobile phone number
        type: string
        example: "123456789"
        required: false
      barcode:
        description: Filter by barcode
        type: string
        example: "925162037753924"
        required: false
      externalSystemId:
        description: Filter by externalSystemId
        type: string
        example: 945d62d8-702c-4ed1-a16b-83146a6d8eef
        required: false
      queryOp:
        description: Query operation for searching
        type: string
        default: "and"
    responses:
      200:
        body:
          application/json:
            type: userTenantCollection
      500:
        description: "Internal server error"
        body:
          text/plain:
            example: "Internal server error"
  post:
    is: [ validate ]
    description: Create a user-tenant
    responses:
      201:
        description: "Returns only 201 status code without body"
      400:
        description: "Bad request, e.g. malformed request body. Details of the error provided in the response."
      401:
        description: "Not authorized to perform requested action"
      422:
        description: "Validation error, e.g. missing required field. Details of the error provided in the response."
      500:
        description: "Internal server error"
  delete:
    description: Delete a user-tenant from member tenant. Deleting from the central tenant is forbidden.
    queryParameters:
      tenantId:
        description: Filter by tenant id
        type: string
        example: sfs000
        required: false
    responses:
      204:
        description: "Successful deletion"
      500:
        description: "Internal server error"
        body:
          text/plain:
            example: "Internal server error"