Redirects Management

UniFed API link

This feature allows administrators to manage and configure URL redirection rules effectively within their systems. It enables the setup of secure and efficient redirects that guide user navigation across different services. This tool is essential for maintaining optimal user experience and ensuring compliance with security policies

Base URL - Staging

1. Create Redirects - This function enables administrators to establish new redirection rules, allowing for seamless navigation and improved routing of user traffic within applications.

curl -i -X POST \
  -u <username>:<password> \
  '<Base URL>/unifed-auth-service/unifed/api/v1/organization/redirects/ \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "<string>",
    "redirect_uri": "<string>",
    "attributes": [
      "<attributeid>"
    ]
  }'

• name
  • Note: special characters are not allowed except "-"

• redirect_uri
  • note: must be valid uri

• attributeid
  • Get attributeid from List Attribute inside the attributes

2. List Redirects - View and manage a comprehensive list of all active URL redirection rules within the system, ensuring efficient navigation and security compliance.

curl -i -X POST \
  -u <username>:<password> \
  '<Base URL>/unifed-auth-service/unifed/api/v1/organization/filter/redirects/ \
  -H 'Content-Type: application/json' \
  -d '{
    "query": {},
    "page": {
      "size": 10,
      "page_number": 1
    },
    "filter": [
      {
        "key_name": "name",
        "key_value": "test",
        "operator": "!="
      }
    ],
    "sort": "asc"
  }'

• query (Not mandatory)
  • {"key_name":"Key_value"}
  • acts like == operator

• pageSize
  • Counts per page(10)
  • page_number - Page Number(1)

• ex
  • if page_number is 2 and Size is 10, it skips the first 10 data and delivers 2nd10 data which is 11- 20.

• filter (Advanced search)
  • key_name - attribute_name
  • ex: givenName
• key_value - actual value
  • ex: Adam
• operator - "=="
  • list of operators user can use:[ "like", "==", ">=", ">", "<=", "<", "!=", "notlike" ]
  • If anything is given other than this will be taken as ==

• sort
  • asc - ascending
  • desc - descending
  • If not given it will be taken as asc randomly given something will be taken as desc

3. Get Redirects - Retrieve a list of all configured redirect rules, allowing for easy review and management of URL redirection settings within the system.

curl -i -X PUT \
  -u <username>:<password> \
  '<Base URL>/unifed-auth-service/unifed/api/v1/organization/redirects/ \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "<string>"
  }'

• payload = { "id": "<string>" }
• id We can get id from the List Redirects API.

4. Update Redirects - Modify existing URL redirection rules to enhance navigation efficiency and security compliance within the system.

curl -i -X PATCH \
  -u <username>:<password> \
  '<Base URL>/unifed-auth-service/unifed/api/v1/organization/redirects/ \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "<string>",
    "redirect_uri": "<string>",
    "attributes": [
      "<attributeid>"
    ]
  }'

• id We can get id from the List Redirects API
• redirect_uri
  • note: must be valid uri
• attributeid
  • Get attributeid from List Attribute API inside the attributes

5. Delete Redirects - This enables administrators to remove existing redirect rules, ensuring that URL redirection policies stay relevant and streamlined within the system.

curl -i -X DELETE \
  -u <username>:<password> \
  '<Base URL>/unifed-auth-service/unifed/api/v1/organization/redirects/?id=%3Cstring%3E'

query = { "id": "<string>" }

id We can get id from the List Redirects API