Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in
It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

User Provisioning REST API Patch User

I can't seem to find details for the User provisioning API's patch user.  They give the following format:

 

{ "schemas": [ "<string>" ], "operations": [ { "op": "<string>", "path": "<string>", "value": { "array": true, "null": true, "valueNode": true, "containerNode": true, "missingNode": true, "object": true, "nodeType": "ARRAY", "pojo": true, "number": true, "integralNumber": true, "floatingPointNumber": true, "short": true, "int": true, "long": true, "double": true, "bigDecimal": true, "bigInteger": true, "textual": true, "boolean": true, "binary": true, "float": true } } ] }

 

Schemas: I think might be one (or all) of these

"urn:scim:schemas:extension:atlassian-external:1.0",        "urn:ietf:params:scim:schemas:core:2.0:User",        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"

 

Operations.op: I have no idea what it is and there's no reference to a resource describing them.

Operations.path: Once again, I don't know the format.  Maybe  something like "name.familyName"?

Operations.value: If path points to the property, then I assume this is just the value for the property.

 

If I could get a real example or a resource that points out the missing information, that would help a ton.

1 answer

1 accepted

0 votes
Answer accepted

I managed to figure this out.  For future reference,

schemas should be "urn:ietf:params:scim:api:messages:2.0:PatchOp". 

op valid values are: add, remove, replace.

path is the property path.  Ex: name.familyName

value is the string or json to add or replace.  You'd use JSON for something like the name property and string for something like name.familyName.

Hi @Scott ,

I was looking for a working solution for the PATCH API. My API request is :

curl --request PATCH \
--url 'https://api.atlassian.com/scim/directory/{directoryId}/Users/{userId}' \
--header 'Authorization: Bearer <token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"schemas":[
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"operations": [
{
"op": "replace",
"path": "title",
"value": "Developer"
}
]
}'

I have created the user using POST API yesterday and trying to use PATCH to update it. However, I am not seeing any changes. 

Is there a mistake in my API call or do I need to wait for some time before the PATCH operation gives me the changes?

Seems correct.  There is a small delay between the update in user provisioning and things updating in Jira.  But, it's not much.  I think a couple minutes at most, that I've noticed.  I'm not using the title field, so it could be something related to that.

I was updating using the user provisioning api and also using the fetch api of provisioning to fetch the particular user. I just took an example of the title field, I tried using userName, name.givenName, name.familyName also but none of the changes were reflected. 

Here's my C# code that updates the name.

sshot-1.png

Like Mrinalini Pal likes this

In the response of this api are you seeing the values updated?

So, the response from the call, I don't do anything with it.  So, I don't know about that.  As far as does it make a change in Jira, I checked my logs and have a last name change that happened on the 21st that shows updated in Jira.

I understood why I was not seeing any changes. I was trying to perform the PATCH operation on users having emails outside the domain. The PATCH operation is working fine for the users within the domain.

Thanks for your help!

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
TAGS
Community showcase
Published in Atlassian Access

Atlassian Access Demo Q&A Recap

Hi Community! Thank you to all who joined our ongoing monthly Atlassian Access demo! We have an engaging group of attendees who asked many great questions. I’ll share a recap of frequently ask...

455 views 1 4
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you