Adding information to a custom field through API, is it possible?

cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 
Announcements

Welcome Idira to LIVEcommunity!

Our community just got stronger! Explore new identity security resources, connect with experts, and discover more ways to learn and collaborate.

Meet Idira

Adding information to a custom field through API, is it possible?

L0 Member

I have created a custom field in the PVWA for one of my policies/accounts, I am trying to add a new account with the API but I am able to add information to the custom field through the API. If so how?

1 accepted solution

Accepted Solutions

L2 Linker

Hello,

 

The following two REST API commands should be able to help you out here:

https://cyberarkdocu.azurewebsites.net/Product-Doc/OnlineHelp/PAS/Latest/en/Content/WebServices/Add%20Account%20v10.htm

https://cyberarkdocu.azurewebsites.net/Product-Doc/OnlineHelp/PAS/Latest/en/Content/SDK/UpdateAccount%20v10.htm

 

For add account look at this section:

===

Parameter

platformAccountProperties

 

Type

String

 

Description

Object containing key-value pairs to associate with the account, as defined by the account platform. Optional properties that do not exist on the account will not be returned here. Internal properties are not returned.

 

Valid values

example: {"Location": "IT", "OwnerName": "MSSPAdmin"}===

===

 

Thanks,

Henry

View solution in original post

3 REPLIES 3

L4 Transporter

@Quaid Anderson​  Depending on whether the custom field was mandatory or optional, you should be able to add the account via API

L2 Linker

Hello,

 

The following two REST API commands should be able to help you out here:

https://cyberarkdocu.azurewebsites.net/Product-Doc/OnlineHelp/PAS/Latest/en/Content/WebServices/Add%20Account%20v10.htm

https://cyberarkdocu.azurewebsites.net/Product-Doc/OnlineHelp/PAS/Latest/en/Content/SDK/UpdateAccount%20v10.htm

 

For add account look at this section:

===

Parameter

platformAccountProperties

 

Type

String

 

Description

Object containing key-value pairs to associate with the account, as defined by the account platform. Optional properties that do not exist on the account will not be returned here. Internal properties are not returned.

 

Valid values

example: {"Location": "IT", "OwnerName": "MSSPAdmin"}===

===

 

Thanks,

Henry

L0 Member

Thanks Henry for the how to update a custom field. How about adding the custom field to the platform via the API?

  • 1 accepted solution
  • 587 Views
  • 3 replies
  • 0 Likes
Like what you see?

Show your appreciation!

Click Like if a post is helpful to you or if you just want to show your support.

Click Accept as Solution to acknowledge that the answer to your question has been provided.

The button appears next to the replies on topics you’ve started. The member who gave the solution and all future visitors to this topic will appreciate it!

These simple actions take just seconds of your time, but go a long way in showing appreciation for community members and the LIVEcommunity as a whole!

The LIVEcommunity thanks you for your participation!