UniFed - Organization Management - API

UniFed API link

Organization Management in UniFed allows administrators to configure and manage organizational settings and structures. It includes features for user roles, access permissions, and resource allocation. This functionality ensures streamlined operations and effective governance within the organization.

Base URL - Staging

Create Organization - UniFed enables administrators to establish a new organizational unit within the system. It allows for the configuration of foundational settings, including organizational name, structure, and initial user roles.

curl -i -X POST \
  -u <username>:<password> \
  https://unifed-dev-api.infisign.net/unifed-auth-service/unifed/api/v1/organization/ \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "<string>",
    "description": "<string>",
    "logo": "<string>",
    "domain": "<string>"
  }'

name - ex: Infisign

Note: Special characters are not allowed except "-"

logo via link (ex: s3 link)

List Organization - A comprehensive overview of all registered organizations within the system. It allows administrators to view, search, and manage organization details easily.

curl -i -X POST \
  -u <username>:<password> \
  https://unifed-dev-api.infisign.net/unifed-auth-service/unifed/api/v1/organization/filter/ \
  -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"} ex: { name: Infisign }

Note: acts like == operatorDefault: {}

pagesize - Counts per page(ex: 10) page_number - Page Number(ex: 1) ex: If page_number is 2 and size is 10, it skips the first 10 data and deliver 2nd 10 data which is 11- 20.

filter (Not mandatory - Advanced search)

key_name - Key name of created organiztion data

ex: name, is_active

key_value - Key value of created organiztion data

ex: sampleWidget, false

operator - List of operators allowed like, ==, >=, >, <=, <, !=, notlike

like - Case insensitive and works like normal search ex: Searching hello filters worlds containing hello returns Hello, HelloWorld etc

notlike - Opposite to like(case insensitive) ex: Searching hello filters worlds not containing hello returns UniFed Default: [ ]

sort

List of sort allowed asc, desc asc - ascending desc - descending

Update Organization Profile - Updating the organization profile in UniFed allows administrators to modify essential details such as the organization's name, contact information, and branding elements.

curl -i -X PATCH \
  -u <username>:<password> \
  'https://unifed-dev-api.infisign.net/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/profile/' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "<string>",
    "description": "<string>",
    "logo": "<string>",
    "domain": "<string>"
  }'

name

ex: Infisign

Note: Special characters are not allowed except "-"

logo via link (ex: s3 link)

Update Organization Redirects - The Update Organization Redirects feature allows administrators to configure custom URLs for redirecting users during specific events, such as login errors or post-authentication.

curl -i -X PATCH \
  -u <username>:<password> \
  'https://unifed-dev-api.infisign.net/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/redirects_profile/' \
  -H 'Content-Type: application/json' \
  -d '{
    "redirect_ids": [
      "<string>",
      "<string>"
    ]
  }'

redirect_ids Get id from the List Redirects API

Create Organization Users - Creating organization users in UniFed involves adding new members to your organization, assigning roles, and setting access permissions. This process ensures that users have the appropriate privileges and access to resources needed for their roles.

curl -i -X POST \
  -u <username>:<password> \
  'https://unifed-dev-api.infisign.net/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/users/' \
  -H 'Content-Type: application/json' \
  -d '{
    "givenName": "<string>",
    "emailId": "<string>",
    "mobileNumber": "<string>",
    "countryCode": "<string>",
    "secondaryEmailIds": "<email1>,<email2>",
    "schemaId": "<string>"
  }'

mobileNumber - Mobile number without country code ex: 9876543210

countryCode Country Code ex: +91

secondaryEmailIds Separate email Id with comma ex: "example@gmail.com, sample@gmail.com"

schemaId Get schemaId from the List schema API

List of Organization users - The List of Organization Users feature in UniFed provides a comprehensive view of all users within the organization.

curl -i -X POST \
  -u <username>:<password> \
  'https://unifed-dev-api.infisign.net/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/filter/users/' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": {},
    "page": {
      "size": 10,
      "page_number": 1
    },
    "filter": [
      {
        "key_name": "givenName",
        "key_value": "test",
        "operator": "!="
      }
    ],
    "sort": "asc"
  }'

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

page

Size - 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 deliver 2nd 10 data which is 11- 20.

filter (Advanced Search)

key_name - attribute_name

ex: givenName

key_value - actual value

ex: Sachin

operator - "=="

list of operators user can use:[ "like", "==", ">=", ">", "<=", "<", "!=", "notlike" ]

If anything given other than this will be takenas ==

sort

asc - ascending

desc - descending If not given it will be takes as asc

If randomly gave something it will be taken as desc

Get Organization Users - comprehensive list of users within your organization, including their roles and access levels.

curl -i -X PUT \
  -u <username>:<password> \
  'https://unifed-dev-api.infisign.net/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/users/' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "<string>"
  }'

id Get id from the List Organization Users API

Update Organization Users - Easily manage and update user information within your organization.

curl -i -X PATCH \
  -u <username>:<password> \
  'https://unifed-dev-api.infisign.net/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/users/' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "<string>",
    "givenName": "<string>",
    "emailId": "<string>",
    "countryCode": "<string>",
    "mobileNumber": "<string>",
    "secondaryEmailIds": "<email1>,<email2>",
    "schemaId": "<string>"
  }'

id - Get id from the List Organization Users API

mobileNumber - Mobile number without country code ex: 9876543210

countryCode - Country Code ex: +91

secondaryEmailIds - Separate email Id with comma ex: "example@gmail.com, sample@gmail.com"

schemaId - Get schemaId from the List schema API

Delete Organization Users - The "Delete Organization Users" feature in UniFed enables administrators to remove users from the organization.

curl -i -X PUT \
  -u <username>:<password> \
  'https://unifed-dev-api.infisign.net/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/users/delete/' \
  -H 'Content-Type: application/json' \
  -d '{
    "emailId": "<string>",
    "countryCode": "<string>",
    "mobileNumber": "<string>"
  }'

id - Get id from the List Organization Users API