Re: [scim] [EXTERNAL] Query on a specific known resource

[Phillip Hunt <[e-mail]>]

All forms of queries (via GET or POST) required a ListResponse per sec 3.4.2. 

It does not matter if only one resource is returnable.  This is important because if there is no match, total results is 0 even if it could only be one match.  

“ Responses MUST be identified using the following URI:
   "urn:ietf:params:scim:api:messages:2.0:ListResponse".  The following
   attributes are defined for responses:

   totalResults  The total number of results returned by the list or
      query operation.  The value may be larger than the number of
      resources returned, such as when returning a single page (see
      Section 3.4.2.4) of results where multiple pages are available.
      REQUIRED.

   Resources  A multi-valued list of complex objects containing the
      requested resources.  This MAY be a subset of the full set of
      resources if pagination (Section 3.4.2.4) is requested.  REQUIRED
      if "totalResults" is non-zero.

   startIndex  The 1-based index of the first result in the current set
      of list results.  REQUIRED when partial results are returned due
      to pagination.

   itemsPerPage  The number of resources returned in a list response
      page.  REQUIRED when partial results are returned due to
      pagination.“

Phil

> On Jul 6, 2022, at 7:51 PM, Danny Zollner <Danny.Zollner=[e-mail]> wrote:
> 
> 
> Hi Julien,
>  
> RFC 7644 section 3.4.2 specifically is talking about queries. Retrieving or modifying known resources (i.e.: GET /Users/12345 ) does not require a ListResponse type response. A query of GET /Users?filter=displayname contains “contoso.com” or GET /Users?attributes=userName would require a ListResponse type response, as it does not identify a specific resource in the query URL via ID value (i.e.: “12345” in the previous example). On the other hand, GET /Users/12345?attributes=userName does not require the ListResponse type response as it does identify a specific resource.
>  
> To explicitly answer the final question in your email – the expected response to GET /Users/2819c223-7f76-453a-919d-413861904646?attributes=userName would be the second example you provided.
>  
> Cheers,
>  
> Danny Zollner
>  
> From: scim <[e-mail]> On Behalf Of Julien Schneider
> Sent: Wednesday, July 6, 2022 3:41 AM
> To: [e-mail]
> Subject: [EXTERNAL] [scim] Query on a specific known resource
>  
> Some people who received this message don't often get email from [e-mail]. Learn why this is important
> Hi all,
> 
> I have a question about queries performed against a SCIM resource object (like "/Users/{id}").
> 
> The RFC (https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2) states:
> Responses MUST be identified using the following URI:
>    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
> 
> If I understand correctly, that means the "schemas" parameter of the response to those queries must be set to:
> "schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"]
> 
> While I understand how that applies to queries on a resource type endpoint (like "/Users") or on the SCIM server root, I don't understand how that applies to queries on a specific resource object.
> If I understand correctly, queries on a specific resource object actually are quite identical to "retrieving a known resource" (https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.1) which are a GET on a specific resource, like:
> GET /Users/2819c223-7f76-453a-919d-413861904646
> Responses to those requests should have the "schemas" parameter set to the resource schema(s):
> {
>      "schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],
>      "id":"2819c223-7f76-453a-919d-413861904646",
> ...
> }
> 
> Now, how should the response to the following query should look like? And to what value should the "schemas" parameter of the response be set?
> GET /Users/2819c223-7f76-453a-919d-413861904646?attributes=userName
> 
> Should it be:
>    {
>      "schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
>      "totalResults":1,
>      "Resources":[
>        {
>          "id":"2819c223-7f76-453a-919d-413861904646",
>          "userName":"bjensen"
>        }
>      ]
>    }
> 
> Or something like:
>    {
>      "schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],
>      "id":"2819c223-7f76-453a-919d-413861904646",
>      "meta":{
>        "resourceType":"User",
>        "created":"2011-08-01T18:29:49.793Z",
>        "lastModified":"2011-08-01T18:29:49.793Z",
>        "location":
>    "https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646",
>        "version":"W\/\"f250dd84f0671c3\""
>      },
>      "userName":"bjensen"
>    }
> 
> Thanks a lot in advance
> 
> -- 
> Julien Schneider
> Tel: [phone]
> Fax: [phone]
>  
> http://www.audriga.com | http://www.twitter.com/audriga
>  
> --------------------------------------------------------------------------
> audriga GmbH |  Alter Schlachthof 57  | 76137 Karlsruhe
> Sitz der Gesellschaft: Karlsruhe - Amtsgericht Mannheim - HRB 713034
> Geschäftsführer: Dr. Frank Dengler, Dr.-Ing. Hans-Jörg Happel
> --------------------------------------------------------------------------
> _______________________________________________
> scim mailing list
> [e-mail]
> https://www.ietf.org/mailman/listinfo/scim