jmpapi/api/jmpapi-auth.yaml at master · CauldronDevelopmentLLC/jmpapi · 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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
---
title: Authorization

help: >
  API Authorization endpoints allow for creating, modifying or deleting users
  and groups.  The login system uses OAuth2 and can support Google, Facebook,
  or GitHub as login providers.

endpoints:
  /.*:
    get|put|post|delete:
      handler: session
      help: Look up session by ID.
      sql: CALL jmpapi.AuthSession({session.id})

  /((login)|(logout)|(config)|(users)|(groups)).*:
    get|put|post|delete:
      handler: pass
      headers: {Cache-Control: max-age=0}

  /login/{provider}:
    args:
      provider:
        enum: [google, facebook, github, providers, '']
        help: >
          The OAuth2 login provider or ``providers`` to list supported
          providers.

    get:
      handler: login
      sql: >
        CALL jmpapi.AuthLogin({session.id}, {session.provider},
          {session.provider_id}, {session.user}, {session.name},
          {session.avatar})

  /logout:
    put:
      handler: logout
      sql: CALL jmpapi.AuthLogout({session.id})
      help: Close the currently logged in session.

  /config:
    allow: [$admin]

    get:
      return: list
      sql: CALL jmpapi.ConfigList()

    /{name}:
      get:
        return: one
        sql: CALL jmpapi.ConfigGet({args.name})

      put:
        args:
          value: {}
        sql: CALL jmpapi.ConfigSet({args.name}, {args.value})

  /users:
    get:
      allow: [$admin]
      return: list
      sql: CALL jmpapi.UserList()
      help: Returns a list of all users.

    post:
      return: u64
      allow: [$admin]
      args:
        provider:
          enum: [google, facebook, github]
          help: The OAuth2 login provider.
        provider_id: {optional: true, min: 1}
        email: {type: email, help: "The user's email address."}
        name: {optional: true, min: 2, help: "The user's name."}
        avatar:
          optional: true
          type: uri
          help: "A URL pointing to the user's avatar"
        enabled: {type: bool, default: true}

      sql: >
        CALL jmpapi.UserAdd({args.provider}, {args.provider_id},
          {args.email}, {args.name}, {args.avatar}, {args.enabled});
        SELECT @uid;

    /{id}:
      args:
        id:
          help: User ID
          allow: [$admin, =uid]

      get:
        fields: ["*", associations, groups]
        help: Get user info.
        sql: CALL jmpapi.UserGet({args.id})

      put:
        help: Update user settings
        args:
          email: {optional: true, type: email}
          name: {optional: true, min: 2}
          avatar: {optional: true, type: uri}
          enabled: {allow: [$admin], optional: true, type: bool}
        sql: >
          CALL jmpapi.UserSet({args.id}, {args.email}, {args.name},
            {args.avatar}, {args.enabled})

      delete:
        help: Delete an existing user.
        sql: CALL jmpapi.UserDelete({args.id})

      /associations/{provider}:
        args:
          provider:
            enum: [google, facebook, github]
            help: The OAuth2 login provider.

        put:
          help: Add a user login association.
          args:
            provider_id: {optional: true, min: 1}
            email: {optional: true, type: email}
            name: {optional: true, min: 2}
            avatar: {optional: true, type: uri}
          sql: >
            CALL jmpapi.UserAssociationAdd({args.id}, {args.provider},
              {args.provider_id}, {args.email}, {args.name},
              {args.avatar})

        delete:
          help: Delete a user login association.
          sql: CALL jmpapi.UserAssociationDelete({args.id}, {args.provider})

      /groups:
        allow: [$admin]

        get:
          return: list
          sql: CALL jmpapi.UserGroupList({args.id})
          help: Get the list of groups with user membership.

        /{group}:
          put:
            sql: CALL jmpapi.UserGroupAdd({args.id}, {args.group})
            help: Add a user to a group.

          delete:
            sql: CALL jmpapi.UserGroupDelete({args.id}, {args.group})
            help: Remove a user from a group.

  /groups:
    allow: [$admin]

    get:
      return: list
      sql: CALL jmpapi.GroupList()
      help: Returns the list of groups.

    /{group}:
      args:
        group: {help: The group name.}

      put:
        sql: CALL jmpapi.GroupAdd({args.group})
        help: Create a new group.

      delete:
        sql: CALL jmpapi.GroupDelete({args.group})
        help: Delete a group.

      /members:
        get:
          return: list
          sql: CALL jmpapi.GroupMemberList({args.group})
          help: Returns a list of members of a group.

      /nonmembers:
        get:
          return: list
          sql: CALL jmpapi.GroupNonmemberList({args.group})
          help: Returns a list of nonmembers of a group.