Automated commit by github action: 3903649981

2025-12-09 12:27:47 +00:00 · 2023-01-12 15:27:37 +00:00
parent a5bde3131b
commit bad7eba696
8 changed files with 156 additions and 91 deletions
--- a/static/api-specs/idn/beta/paths/oauth-client.yaml
+++ b/static/api-specs/idn/beta/paths/oauth-client.yaml
@@ -1,17 +1,13 @@
 get:
  operationId: getOauthClient
-  # security:
-  #   - oauth2: [idn:oathkeeper-client:read]
+  security:
+    - oauth2: [sp:oauth-client:manage, sp:oauth-client:read]
  tags:
    - OAuth Clients
  summary: Get OAuth Client
  description: >-
    This gets details of an OAuth client.

-    Request will require the following security scope:
-
-    - sp:oauth-client:manage
-    - sp:oauth-client:read
  parameters:
    - in: path
      name: id
@@ -41,17 +37,14 @@ get:
      $ref: '../../v3/responses/500.yaml'
 delete:
  operationId: deleteOauthClient
-  # security:
-  #   - oauth2: [idn:oathkeeper-client:delete,idn:oathkeeper-internal-client:delete]
+  security:
+    - oauth2: [sp:oauth-client:manage]
  tags:
    - OAuth Clients
  summary: Delete OAuth Client
  description: >-
    This deletes an OAuth client.

-    Request will require the following security scopes:
-
-    - sp:oauth-client:manage
  parameters:
    - in: path
      name: id
@@ -77,8 +70,8 @@ delete:
      $ref: '../../v3/responses/500.yaml'
 patch:
  operationId: patchOauthClient
-  # security:
-  #   - oauth2: [idn:oathkeeper-client:update]
+  security:
+    - oauth2: [sp:oauth-client:manage]
  tags:
    - OAuth Clients
  summary: Patch OAuth Client
--- a/static/api-specs/idn/beta/paths/oauth-clients.yaml
+++ b/static/api-specs/idn/beta/paths/oauth-clients.yaml
@@ -1,16 +1,13 @@
 get:
  operationId: listOauthClients
-  # security:
-  #   - oauth2: [idn:oathkeeper-client-list:read]
+  security:
+    - oauth2: [sp:oauth-client:manage]
  tags:
    - OAuth Clients
  summary: List OAuth Clients
  description: >-
    This gets a list of OAuth clients.

-    Request will require the following security scope:
-
-    - sp:oauth-client:manage
  responses:
    '200':
      description: List of OAuth clients.
@@ -32,17 +29,14 @@ get:
      $ref: '../../v3/responses/500.yaml'
 post:
  operationId: createOauthClient
-  # security:
-  #   - oauth2: [idn:oathkeeper-client:create,idn:oathkeeper-internal-client:create]
+  security:
+    - oauth2: [sp:oauth-client:manage]
  tags:
    - OAuth Clients
  summary: Create OAuth Client
  description: >-
    This creates an OAuth client.

-    Request will require the following security scope:
-
-    - sp:oauth-client:manage
  requestBody:
    required: true
    content:
--- a/static/api-specs/idn/beta/paths/personal-access-token.yaml
+++ b/static/api-specs/idn/beta/paths/personal-access-token.yaml
@@ -1,15 +1,71 @@
+patch:
+  operationId: patchPersonalAccessToken
+  security:
+    - oauth2: [sp:my-personal-access-tokens:manage]
+  tags:
+    - Personal Access Tokens
+  summary: Patch Personal Access Token
+  description: >-
+    This performs a targeted update to the field(s) of a Personal Access Token.
+
+  parameters:
+    - in: path
+      name: id
+      schema:
+        type: string
+      required: true
+      description: The Personal Access Token id
+      example: ef38f94347e94562b5bb8424a56397d8
+  requestBody:
+    required: true
+    description: |
+      A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
+
+      The following fields are patchable:
+      * name
+      * scope
+    content:
+      application/json-patch+json:
+        schema:
+          type: array
+          items:
+            $ref: '../schemas/JsonPatchOperation.yaml'
+        example:
+          - op: "replace"
+            path: "/name"
+            value: "New name"
+          - op: "replace"
+            path: "/scope"
+            value: ["sp:scopes:all"]
+  responses:
+    '200':
+      description: >-
+        Indicates the PATCH operation succeeded, and returns the PAT's new representation.
+      content:
+        application/json:
+          schema:
+            $ref: '../schemas/GetPersonalAccessTokenResponse.yaml'
+    "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"
 delete:
  operationId: deletePersonalAccessToken
+  security:
+    - oauth2: [sp:my-personal-access-tokens:manage, sp:all-personal-access-tokens:manage]
  tags:
    - Personal Access Tokens
  summary: Delete Personal Access Token
  description: >-
-    This deletes a personal access token 
-
-    Request will require one of the following security scopes:
-
-      - sp:my-personal-access-tokens:manage
-      - sp:all-personal-access-tokens:manage
+    This deletes a personal access token.
    
  parameters:
    - in: path
--- a/static/api-specs/idn/beta/paths/personal-access-tokens.yaml
+++ b/static/api-specs/idn/beta/paths/personal-access-tokens.yaml
@@ -1,19 +1,14 @@
 get:
  operationId: listPersonalAccessTokens
+  security:
+    - oauth2: [sp:my-personal-access-tokens:read, sp:my-personal-access-tokens:manage, sp:all-personal-access-tokens:read, sp:all-personal-access-tokens:manage]
  tags:
    - Personal Access Tokens
  summary: List Personal Access Tokens
  description: >-
    This gets a collection of personal access tokens associated with the optional `owner-id`. 
    query parameter. If the `owner-id` query parameter is omitted, all personal access tokens 
-    for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. 
-
-    Request will require one of the following security scopes:
-
-      - sp:my-personal-access-tokens:read
-      - sp:my-personal-access-tokens:manage
-      - sp:all-personal-access-tokens:read
-      - sp:all-personal-access-tokens:manage
+    for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right.
    
  parameters:
    - in: query
@@ -53,16 +48,13 @@ get:
      $ref: "../../v3/responses/500.yaml"
 post:
  operationId: createPersonalAccessToken
+  security:
+    - oauth2: [ sp:my-personal-access-tokens:manage, sp:all-personal-access-tokens:manage ]
  tags:
    - Personal Access Tokens
  summary: Create Personal Access Token
  description: >-
-    This creates a personal access token. 
-
-    Request will require one of the following security scopes:
-
-      - sp:my-personal-access-tokens:manage
-      - sp:all-personal-access-tokens:manage
+    This creates a personal access token.
    
  requestBody:
    description: Name and scope of personal access token.
--- a/static/api-specs/idn/v3/paths/oauth-client.yaml
+++ b/static/api-specs/idn/v3/paths/oauth-client.yaml
@@ -1,17 +1,13 @@
 get:
  operationId: getOauthClient
-  # security:
-  #   - oauth2: [idn:oathkeeper-client:read]
+  security:
+    - oauth2: [sp:oauth-client:manage, sp:oauth-client:read]
  tags:
    - OAuth Clients
  summary: Get OAuth Client
  description: >-
    This gets details of an OAuth client.

-    Request will require the following security scope:
-
-    - sp:oauth-client:manage
-    - sp:oauth-client:read
  parameters:
    - in: path
      name: id
@@ -41,17 +37,13 @@ get:
      $ref: '../responses/500.yaml'
 delete:
  operationId: deleteOauthClient
-  # security:
-  #   - oauth2: [idn:oathkeeper-client:delete,idn:oathkeeper-internal-client:delete]
+  security:
+    - oauth2: [sp:oauth-client:manage]
  tags:
    - OAuth Clients
  summary: Delete OAuth Client
  description: >-
    This deletes an OAuth client.
-
-    Request will require the following security scopes:
-
-    - sp:oauth-client:manage
  parameters:
    - in: path
      name: id
@@ -77,17 +69,14 @@ delete:
      $ref: '../responses/500.yaml'
 patch:
  operationId: patchOauthClient
-  # security:
-  #   - oauth2: [idn:oathkeeper-client:update]
+  security:
+    - oauth2: [sp:oauth-client:manage]
  tags:
    - OAuth Clients
  summary: Patch OAuth Client
  description: >-
    This performs a targeted update to the field(s) of an OAuth client.

-    Request will require a security scope of
-
-    - sp:oauth-client:manage
  parameters:
    - in: path
      name: id
--- a/static/api-specs/idn/v3/paths/oauth-clients.yaml
+++ b/static/api-specs/idn/v3/paths/oauth-clients.yaml
@@ -1,16 +1,13 @@
 get:
  operationId: listOauthClients
-  # security:
-  #   - oauth2: [idn:oathkeeper-client-list:read]
+  security:
+    - oauth2: [sp:oauth-client:manage]
  tags:
    - OAuth Clients
  summary: List OAuth Clients
  description: >-
    This gets a list of OAuth clients.

-    Request will require the following security scope:
-
-    - sp:oauth-client:manage
  responses:
    '200':
      description: List of OAuth clients.
@@ -32,18 +29,14 @@ get:
      $ref: '../responses/500.yaml'
 post:
  operationId: createOauthClient
-  # security:
-  #   - oauth2: [idn:oathkeeper-client:create,idn:oathkeeper-internal-client:create]
+  security:
+    - oauth2: [sp:oauth-client:manage]
  tags:
    - OAuth Clients
  summary: Create OAuth Client
  description: >-
    This creates an OAuth client.

-    Request will require the following security scope:
-
-    - sp:oauth-client:manage
-
  requestBody:
    required: true
    content:
--- a/static/api-specs/idn/v3/paths/personal-access-token.yaml
+++ b/static/api-specs/idn/v3/paths/personal-access-token.yaml
@@ -1,15 +1,71 @@
+patch:
+  operationId: patchPersonalAccessToken
+  security:
+    - oauth2: [sp:my-personal-access-tokens:manage]
+  tags:
+    - Personal Access Tokens
+  summary: Patch Personal Access Token
+  description: >-
+    This performs a targeted update to the field(s) of a Personal Access Token.
+
+  parameters:
+    - in: path
+      name: id
+      schema:
+        type: string
+      required: true
+      description: The Personal Access Token id
+      example: ef38f94347e94562b5bb8424a56397d8
+  requestBody:
+    required: true
+    description: |
+      A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
+
+      The following fields are patchable:
+      * name
+      * scope
+    content:
+      application/json-patch+json:
+        schema:
+          type: array
+          items:
+            $ref: '../schemas/JsonPatchOperation.yaml'
+        example:
+          - op: "replace"
+            path: "/name"
+            value: "New name"
+          - op: "replace"
+            path: "/scope"
+            value: ["sp:scopes:all"]
+  responses:
+    '200':
+      description: >-
+        Indicates the PATCH operation succeeded, and returns the PAT's new representation.
+      content:
+        application/json:
+          schema:
+            $ref: '../schemas/GetPersonalAccessTokenResponse.yaml'
+    '400':
+      $ref: '../responses/400.yaml'
+    '401':
+      $ref: '../responses/401.yaml'
+    '403':
+      $ref: '../responses/403.yaml'
+    '404':
+      $ref: '../responses/404.yaml'
+    '429':
+      $ref: '../responses/429.yaml'
+    '500':
+      $ref: '../responses/500.yaml'
 delete:
  operationId: deletePersonalAccessToken
+  security:
+    - oauth2: [sp:my-personal-access-tokens:manage, sp:all-personal-access-tokens:manage]
  tags:
    - Personal Access Tokens
  summary: Delete Personal Access Token
  description: >-
-    This deletes a personal access token 
-
-    Request will require one of the following security scopes:
-
-      - sp:my-personal-access-tokens:manage
-      - sp:all-personal-access-tokens:manage
+    This deletes a personal access token.
    
  parameters:
    - in: path
--- a/static/api-specs/idn/v3/paths/personal-access-tokens.yaml
+++ b/static/api-specs/idn/v3/paths/personal-access-tokens.yaml
@@ -1,19 +1,14 @@
 get:
  operationId: listPersonalAccessTokens
+  security:
+    - oauth2: [sp:my-personal-access-tokens:read, sp:my-personal-access-tokens:manage, sp:all-personal-access-tokens:read, sp:all-personal-access-tokens:manage]
  tags:
    - Personal Access Tokens
  summary: List Personal Access Tokens
  description: >-
    This gets a collection of personal access tokens associated with the optional `owner-id`. 
    query parameter. If the `owner-id` query parameter is omitted, all personal access tokens 
-    for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. 
-
-    Request will require one of the following security scopes:
-    
-      - sp:my-personal-access-tokens:read
-      - sp:my-personal-access-tokens:manage
-      - sp:all-personal-access-tokens:read
-      - sp:all-personal-access-tokens:manage
+    for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right.
    
  parameters:
    - in: query
@@ -53,16 +48,13 @@ get:
      $ref: "../responses/500.yaml"
 post:
  operationId: createPersonalAccessToken
+  security:
+    - oauth2: [ sp:my-personal-access-tokens:manage, sp:all-personal-access-tokens:manage ]
  tags:
    - Personal Access Tokens
  summary: Create Personal Access Token
  description: >-
-    This creates a personal access token. 
-
-    Request will require one of the following security scopes:
-
-      - sp:my-personal-access-tokens:manage
-      - sp:all-personal-access-tokens:manage
+    This creates a personal access token.
    
  requestBody:
    description: Name and scope of personal access token.