From c7d2706ffc58316fc002af2fcac34643206e2ba4 Mon Sep 17 00:00:00 2001 From: JeethJJ Date: Fri, 16 Aug 2024 15:09:13 +0530 Subject: [PATCH] Add dcr ext_allowed_audience property and scope update endpoint. --- .../docs/apis/restapis/api-resources.yaml | 57 +++++++++++++++++++ .../7.0.0/docs/apis/restapis/oauth-dcr.yaml | 6 ++ .../docs/apis/restapis/api-resources.yaml | 57 +++++++++++++++++++ .../next/docs/apis/restapis/oauth-dcr.yaml | 6 ++ 4 files changed, 126 insertions(+) diff --git a/en/identity-server/7.0.0/docs/apis/restapis/api-resources.yaml b/en/identity-server/7.0.0/docs/apis/restapis/api-resources.yaml index 97cb629bcd..3f64c92d60 100644 --- a/en/identity-server/7.0.0/docs/apis/restapis/api-resources.yaml +++ b/en/identity-server/7.0.0/docs/apis/restapis/api-resources.yaml @@ -404,6 +404,53 @@ paths: ]' x-codegen-request-body-name: body /api-resources/{apiResourceId}/scopes/{scopeName}: + patch: + tags: + - API Resource Scopes + summary: Patch scope specified by the name + description: > + Patch scope specified by the name. Patch operation only supports "displayName" and "description" fields at the moment. + Permission required:
+ * /permission/admin/manage/identity/apiresourcemgt/update
+ Scope required:
+ * internal_api_resource_update + parameters: + - $ref: '#/components/parameters/apiResourceId' + - $ref: '#/components/parameters/scopeName' + responses: + 204: + description: Not Content + 400: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + 401: + description: Unauthorized + 403: + description: Forbidden + 404: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + 500: + description: Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScopePatchModel' + description: This represents the scopes to be patched. + required: true + delete: tags: - API Resource Scopes @@ -1024,6 +1071,16 @@ components: type: string example: "Allows writing greetings" + ScopePatchModel: + type: object + properties: + displayName: + type: string + example: "Write Greetings" + description: + type: string + example: "Allows writing greetings" + SubscribedApplicationGetModel: type: object properties: diff --git a/en/identity-server/7.0.0/docs/apis/restapis/oauth-dcr.yaml b/en/identity-server/7.0.0/docs/apis/restapis/oauth-dcr.yaml index 61a1da3fe2..05c2b0deab 100644 --- a/en/identity-server/7.0.0/docs/apis/restapis/oauth-dcr.yaml +++ b/en/identity-server/7.0.0/docs/apis/restapis/oauth-dcr.yaml @@ -450,6 +450,8 @@ components: type: string request_object_encryption_enc: type: string + ext_allowed_audience: + type: string updateRequest: type: object properties: @@ -525,6 +527,8 @@ components: type: string request_object_encryption_enc: type: string + ext_allowed_audience: + type: string application: type: object properties: @@ -565,6 +569,8 @@ components: type: boolean ext_public_client: type: boolean + ext_allowed_audience: + type: string error: type: object properties: diff --git a/en/identity-server/next/docs/apis/restapis/api-resources.yaml b/en/identity-server/next/docs/apis/restapis/api-resources.yaml index 97cb629bcd..3f64c92d60 100644 --- a/en/identity-server/next/docs/apis/restapis/api-resources.yaml +++ b/en/identity-server/next/docs/apis/restapis/api-resources.yaml @@ -404,6 +404,53 @@ paths: ]' x-codegen-request-body-name: body /api-resources/{apiResourceId}/scopes/{scopeName}: + patch: + tags: + - API Resource Scopes + summary: Patch scope specified by the name + description: > + Patch scope specified by the name. Patch operation only supports "displayName" and "description" fields at the moment. + Permission required:
+ * /permission/admin/manage/identity/apiresourcemgt/update
+ Scope required:
+ * internal_api_resource_update + parameters: + - $ref: '#/components/parameters/apiResourceId' + - $ref: '#/components/parameters/scopeName' + responses: + 204: + description: Not Content + 400: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + 401: + description: Unauthorized + 403: + description: Forbidden + 404: + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + 500: + description: Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ScopePatchModel' + description: This represents the scopes to be patched. + required: true + delete: tags: - API Resource Scopes @@ -1024,6 +1071,16 @@ components: type: string example: "Allows writing greetings" + ScopePatchModel: + type: object + properties: + displayName: + type: string + example: "Write Greetings" + description: + type: string + example: "Allows writing greetings" + SubscribedApplicationGetModel: type: object properties: diff --git a/en/identity-server/next/docs/apis/restapis/oauth-dcr.yaml b/en/identity-server/next/docs/apis/restapis/oauth-dcr.yaml index 61a1da3fe2..05c2b0deab 100644 --- a/en/identity-server/next/docs/apis/restapis/oauth-dcr.yaml +++ b/en/identity-server/next/docs/apis/restapis/oauth-dcr.yaml @@ -450,6 +450,8 @@ components: type: string request_object_encryption_enc: type: string + ext_allowed_audience: + type: string updateRequest: type: object properties: @@ -525,6 +527,8 @@ components: type: string request_object_encryption_enc: type: string + ext_allowed_audience: + type: string application: type: object properties: @@ -565,6 +569,8 @@ components: type: boolean ext_public_client: type: boolean + ext_allowed_audience: + type: string error: type: object properties: