Repository navigation
Provide proper SDK Documentation #790
Description
Activity
Welcome to OCI...
The examples here are better then the docs.
Just ran into this and it was range inducing. This example on using the newer Idenity APi's is miss leading. This patch will remove ALL the users from the group. In order to only remove one user. You need to read the RFC... for this "PATCH" you can find here on the next page (from the link), you will find this
Remove a single member from a group. Some text removed for readability ("..."): PATCH /Groups/acbf3ae7-8463-...-9b4da3f908ce Host: example.com Accept: application/scim+json Content-Type: application/scim+json Authorization: Bearer h480djs93hd8 If-Match: W/"a330bc54f0671c9" { "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"], "Operations":[{ "op":"remove", "path":"members[value eq \"2819c223-7f76-...413861904646\"]" }] }Now I would "assume" I would not have to escape path string value, but you do... Like this:
path=f"members[value eq \"{user.id}\"]"
If not, it will not work at all.
Also don't expect the Group Object that is returned to be correct. The
memberswill returnNoneas of writing this. If you want to verify the user was removed from the group. You need to make another call to get the group details.I really hope this helps you. I have spend a long time banging my head trying to work though there api's and lack of clear docs.
EDIT
I forgot to say theid(of that object) I reference above is NOT the OCID value. It's theuser_idthat is also calledid.See the models:
Examples are always good - but this does not solve the problem of good documentation.
The links you were sharing actually show the problem pretty well:active Gets the active of this User. This documentation is not helpful - not even proper English.
I see that the go SDK has great API documentation (example).
The python SDK only provides rather useless text parts:
It would be great if also the python folks can benefit from good documentation.
Thanks!