Searching...

Matching results

    How to edit an existing API client?

    Steps to Edit existing API Client.

    1. Navigate to Develop > API clients.
    2. From the list, click on the name of an API Client you want to edit. (Refer to Fig 1)
    3. On the API Client’s Details page, click the Edit button. (Refer to Fig 2)
    4. Make the necessary edits depending on the OAuth flow used by the API client. See the relevant section below for fields applicable to each flow.
    5. Click Save and wait for the operation to complete. (Refer to Fig 3.1, 3.2, 3.3)
    6. Once saved, you will be redirected back to the Client Details page.

    Fig 1: Select an API Client

    Fig 2: Click on Edit

    Note: Some fields in the figures above may vary depending on the OAuth Flow.


    Authorization code flow

    For API clients using the Authorization Code flow, you can edit:

    • Name
    • OAuth Flow — You can change the flow type if needed.
    • Redirect URIs – These are the URLs where the user is redirected after successful authentication. They must match exactly and are required for secure OAuth redirection.
    Fig 3.1: Edit and Save the Modified Details

    Client credentials flow

    For API clients using the Client Credentials flow, you can edit:

    • Name
    • OAuth Flow — You can change the flow type if needed.
    • Profiles - Define the permissions and capabilities assigned to this client.(for more details, refer to this page)
    Fig 3.2: Edit and Save the Modified Details

    Resource owner flow / Authorization code flow (deprecated)

    For API clients using the Resource Owner flow (or deprecated Authorization Code flow), you can edit:

    • Name
    • Redirect URIs – These are the URLs where the user is redirected after successful authentication. They must match exactly and are required for secure OAuth redirection.
    Fig 3.3: Edit and Save the Modified Details

    TOP