Delete a Screen

Endpoint URL: {identityDomain} /config/{appId} /flows/{flow} /screens/{screen}



Description

Removes the specified screen. Note that calling the DELETE method only removes the screen; it does not remove any forms or fields associated with the screen.


Respects the API Client Allow List:  No

API Client Permissions

The following table indicates the API clients that can (and the API clients that can't) be used to call this endpoint:

owner
access_issuer
direct_access
direct_read_access
login_client
Yes
No
Yes
No
No


Authentication

This endpoint supports Basic authentication. 

How to Create an Authentication String


Base URL

The base URL for this endpoint is your Identity Cloud Configuration API domain followed by /config/ followed by your application ID. For example, if you are in the US region and your application ID is htb8fuhxnf8e38jrzub3c7pfrr, then your base URL would be:


https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr

Allowed regions are:

  • us 
  • eu 
  • au 
  • sa 
  • cn
  • sg


Sample Request (curl)

This command deletes the screen testScreen associated with the standard flow and the application htb8fuhxnf8e38jrzub3c7pfrr.


curl -X DELETE \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/standard/screens/testScreen \
  -H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg='

      Running this command in Postman


Responses

204 No Content

If the screen is successfully deleted you will see the HTTP status code 204 No Content.

404 Not Found

Screen could not be found. Please check the value and try again.

Response Example (application/json)


{
  "errors": "Screen not found."
}