See api-docs Menu
  1. Home >
  2. API >
  3. 2 >
  4. Users >
  5. Delete Custom Attribute

Delete Custom Attribute

Use this API to permenantly delete a custom attribute from OneLogin.

Be Careful

This operation can not be undone. All users with this attribute will have the field and any contained data removed.



Resource URL

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

Header Parameter

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.

Resource Parameter

id

required

integer

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

Sample Response

  • 204 No Content
  • 401 Unauthorized
  • 404 Not Found
On success, no content is returned in the response body.

Typically, this error means that your access token value is invalid.

{
    "message": "Unauthorized",
    "name": "UnauthorizedError",
    "statusCode": 401
}
{
    "message": "The resource with the given id could not be found",
    "name": "NotFoundError",
    "statusCode": 404
}

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.