See api-docs Menu

Update Custom Attribute

Use this API to update a custom attribute in OneLogin.

Resource URL

https://<subdomain>/api/2/custom_attributes/:id

Header Parameters

Authorization

required

string

Set to bearer:<access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Manage users or Manage All.

Content-Type

required

string

Set to application/json.

Resource Parameter

id

required

integer

Set to the id of the custom attribute that you want to update. If you don’t know the user’s id, use the List Custom Attributes API call to return all custom attributes and their id values.

Request Parameters

name

required

string A descriptive name for the custom field.
shortname

required

string A unique identifier for the custom field.

Sample Request Body

{
  "name":"Updated Custom Field",
  "shortname":"updatedcustomfield",
  }

Postman Collection

Replace sample variables indicated by < > in the sample request body with your actual values. Also, be sure to set Postman-specific environment variables indicated by {{ }}.

Run In Postman

    Clicking Run in Postman button navigates to the page where you can fork the collection to your workspace. Forking the collection into your workspace will enable you to contribute to the source collection using pull requests. You can also view the collection in a public workspace if you like and even import a copy of the collection using the links present on the screen.

Have a Question?

Found a problem or a bug? Submit a support ticket.

Looking for walkthroughs or how-to guides on OneLogin's user and admin features? Check out the documentation in our Knowledge Base.

Have a product idea or request? Share it with us in our Ideas Portal.