From 8cb513cca36aa4d778a42edc3459139d8f763208 Mon Sep 17 00:00:00 2001 From: Sam Gunaratne Date: Tue, 6 Jan 2026 09:37:03 -0700 Subject: [PATCH] User guids can be client ids --- .../components/parameters/UserGuid.yaml | 6 +++ apis/cf/latest/components/schemas/User.yaml | 49 +++++++++++-------- .../schemas/UserRelationshipToOne.yaml | 3 +- apis/cf/latest/paths/Users.yaml | 10 ++-- 4 files changed, 41 insertions(+), 27 deletions(-) create mode 100644 apis/cf/latest/components/parameters/UserGuid.yaml diff --git a/apis/cf/latest/components/parameters/UserGuid.yaml b/apis/cf/latest/components/parameters/UserGuid.yaml new file mode 100644 index 0000000..3de29c3 --- /dev/null +++ b/apis/cf/latest/components/parameters/UserGuid.yaml @@ -0,0 +1,6 @@ +name: guid +in: path +required: true +schema: + type: string +description: The unique identifier for the user, matching either a UAA user id or client id. A client id may not be a uuid. diff --git a/apis/cf/latest/components/schemas/User.yaml b/apis/cf/latest/components/schemas/User.yaml index 5c9414e..6252481 100644 --- a/apis/cf/latest/components/schemas/User.yaml +++ b/apis/cf/latest/components/schemas/User.yaml @@ -1,21 +1,30 @@ type: object -allOf: - - $ref: './BaseSchema.yaml' - - properties: - username: - type: [string, "null"] - description: The username of the user - presentation_name: - type: string - description: The presentation name of the user - origin: - type: [string, "null"] - description: The origin of the user - metadata: - $ref: './Metadata.yaml' - links: - type: object - properties: - self: - $ref: './Link.yaml' - description: The URL to get this user \ No newline at end of file +properties: + guid: + type: string + description: Unique identifier for the user, matching either a UAA user id or client id. A client id may not be a uuid. + created_at: + type: string + format: date-time + description: The ISO8601 compatible date and time when resource was created + updated_at: + type: string + format: date-time + description: The ISO8601 compatible date and time when resource was last updated + username: + type: [string, "null"] + description: The username of the user + presentation_name: + type: string + description: The presentation name of the user + origin: + type: [string, "null"] + description: The origin of the user + metadata: + $ref: './Metadata.yaml' + links: + type: object + properties: + self: + $ref: './Link.yaml' + description: The URL to get this user \ No newline at end of file diff --git a/apis/cf/latest/components/schemas/UserRelationshipToOne.yaml b/apis/cf/latest/components/schemas/UserRelationshipToOne.yaml index 0cb4c8b..12e2fef 100644 --- a/apis/cf/latest/components/schemas/UserRelationshipToOne.yaml +++ b/apis/cf/latest/components/schemas/UserRelationshipToOne.yaml @@ -10,8 +10,7 @@ properties: properties: guid: type: string - format: uuid - description: The GUID of the user + description: The GUID of the user, matching either a UAA user id or client id. A client id may not be a uuid. required: - guid additionalProperties: false diff --git a/apis/cf/latest/paths/Users.yaml b/apis/cf/latest/paths/Users.yaml index 904fe87..f844746 100644 --- a/apis/cf/latest/paths/Users.yaml +++ b/apis/cf/latest/paths/Users.yaml @@ -18,7 +18,7 @@ type: array items: type: string - description: Comma-delimited list of user guids to filter by + description: Comma-delimited list of user guids to filter by (can include UAA user IDs or client IDs) - name: usernames in: query schema: @@ -111,7 +111,7 @@ tags: - Users parameters: - - $ref: '../components/parameters/Guid.yaml' + - $ref: '../components/parameters/UserGuid.yaml' responses: '200': description: OK @@ -127,12 +127,12 @@ $ref: '../components/responses/Forbidden.yaml' patch: summary: Update a user - description: Update a user’s metadata. + description: Update a user's metadata. operationId: updateUser tags: - Users parameters: - - $ref: '../components/parameters/Guid.yaml' + - $ref: '../components/parameters/UserGuid.yaml' requestBody: $ref: '../components/requestBodies/UserUpdate.yaml' responses: @@ -161,7 +161,7 @@ tags: - Users parameters: - - $ref: '../components/parameters/Guid.yaml' + - $ref: '../components/parameters/UserGuid.yaml' responses: '202': description: Accepted