See api-docs Menu

Delete an App Parameter

Use this API to delete a custom parameter from an app.

Note that you can not delete a parameter that is defined on the apps underlying connector.

Early Access Release

This API is currently in early preview release and may be subject to future breaking changes. If you’re interested in using this API please contact your account manager or our support team.

Be careful, this operation is final and can not be undone.

Resource URL

https://api.<us_or_eu>.onelogin.com/api/2/apps/:id/parameters/:parameter_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: Read All, or Manage All.

Resource Parameter

id

required

integer

Set to the id of the app that you want to update. If you don’t know the app id, use the List Apps API call to return all apps and their id values.

parameter_id

required

integer

Set to the id of the parameter that you want to delete. If you don’t know the app parameter_id, use the Get App API call to return the app configuration which will includ the parameters and their id values.

Sample Responses

Success. The parameter has been deleted. No content is returned.

Typically, this error means that your Authorization header value is missing or incorrectly formatted. The Authorization header value should use this format: bearer:<access_token>.

{
    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"
}

You attempted to delete a connector level parameter.

{
    "message": "not allowed to destroy Parameter 89804:saml_username",
    "statusCode": 403,
    "name": "ForbiddenError"
}

You attempted to delete a parameter that does not exist.

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

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Download for the Apps API

Sample Code

cURL

Replace sample values indicated by < > with your actual values.

Delete App Parameter

curl 'https://api.<us_or_eu>>.onelogin.com/api/2/apps/:id/parameters/:parameter_id' \
-X DELETE \
-H "Authorization: bearer <access_token>"

Have a Question?

Have a how-to question? Seeing a weird error? Ask us about it on StackOverflow.

Found a bug? Submit a support ticket.

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