Organization Management

Oversee organizational details and Single Sign-On (SSO) integrations.

List Organization

Retrieve a detailed list of all organizations registered within the system, including their respective attributes and settings.

SecuritybasicAuth or bearerAuth

Request

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Request Body schema: application/json

object

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

post/unifed-auth-service/unifed/api/v1/organization/filter/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>",
"data": {"total": 10,
"page_number": 1,
"tenants": [{"name": "<string>",
"description": "<string>",
"logo": "<string>",
"domain": "<string>",
"idp_metadata_link": "<string>",
"idp_metadata": "<string>",
"entity_id": "<string>",
"sp_metadata_link": "<string>",
"sso_provider_name_saml": "<string>",
"sso_provider_logo_saml": "<string>",
"sso_provider_name_openid": "<string>",
"sso_provider_logo_openid": "<string>",
"tenant_id": "<string>",
"redirect_details": [{"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
},
{"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
}
],
"sso_redirect_details_saml": {"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
},
"sso_redirect_details_openid": {"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
},
"openid_idp_endpoint": "<string>",
"openid_idp_details": { },
"openid_client_details": { },
"tenant_unique_identifier": "<string>",
"sub_tenant_unique_identifier": "<string>",
"created": "<string>",
"updated": "<string>",
"directory_synced": false,
"no_of_users": 0,
"magic_auth_enabled": false,
"magic_auth_two_step_verify_enabled": true,
"magic_auth_expiry_seconds": 900,
"magic_auth_secret": "<string>"
},
{"name": "<string>",
"description": "<string>",
"logo": "<string>",
"domain": "<string>",
"idp_metadata_link": "<string>",
"idp_metadata": "<string>",
"sso_provider_name_saml": "<string>",
"sso_provider_logo_saml": "<string>",
"sso_provider_name_openid": "<string>",
"sso_provider_logo_openid": "<string>",
"entity_id": "<string>",
"sp_metadata_link": "<string>",
"tenant_id": "<string>",
"redirect_details": [{"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
},
{"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
}
],
"sso_redirect_details_saml": {"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
},
"sso_redirect_details_openid": {"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
},
"openid_idp_endpoint": "<string>",
"openid_idp_details": { },
"openid_client_details": { },
"tenant_unique_identifier": "<string>",
"sub_tenant_unique_identifier": "<string>",
"created": "<string>",
"updated": "<string>",
"directory_synced": false,
"no_of_users": 0,
"magic_auth_enabled": false,
"magic_auth_two_step_verify_enabled": true,
"magic_auth_expiry_seconds": 900,
"magic_auth_secret": "<string>"
}
]
}
}

Create Organization

Test

SecuritybasicAuth or bearerAuth

Request

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Request Body schema: application/json

object

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

post/unifed-auth-service/unifed/api/v1/organization/

Request samples

Response samples

201
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>"
}

Get Organization Profile

Retrieve detailed information about an organization's profile, including its structure, settings, and attributes.

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

header Parameters

Accept

string

Example: application/json

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

get/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/profile/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>",
"data": {"name": "<string>",
"description": "<string>",
"logo": "<string>",
"domain": "<string>",
"created": "<string>",
"updated": "<string>"
}
}

Update Organization Profile

Modify and enhance your organization's profile details to keep your business information current and accurate.

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Request Body schema: application/json

object

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

patch/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/profile/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>",
"data": {"name": "<string>",
"description": "<string>",
"logo": "<string>",
"domain": "<string>",
"created": "<string>",
"updated": "<string>"
}
}

Get Organization Redirects

Retrieve the list of URL redirection rules configured for the organization.

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

header Parameters

Accept

string

Example: application/json

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

get/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/redirects_profile/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>",
"data": {"redirect_details": [{"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
},
{"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
}
],
"created": "<string>",
"updated": "<string>"
}
}

Update Organization Redirects

Modify existing URL redirection rules to optimize navigation and enhance security across your organization’s digital platforms.

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Request Body schema: application/json

object

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

patch/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/redirects_profile/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>",
"data": {"redirect_details": [{"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
},
{"id": "<string>",
"name": "<string>",
"redirect_uri": "<string>",
"redirect_type": "<string>",
"created": "<string>",
"updated": "<string>",
"attributes": [{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
},
{"id": "<string>",
"attribute_name": "<string>",
"attribute_type": "<string>",
"created": "<string>",
"updated": "<string>",
"is_default": false
}
]
}
],
"created": "<string>",
"updated": "<string>"
}
}

List Organization Users

Retrieve a comprehensive list of all users within the organization, including their roles and status.

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Request Body schema: application/json

object

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

post/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/filter/users/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>",
"data": {"total": 10,
"page_number": 1,
"users": [{"id": "<string>",
"givenName": "<string>",
"emailId": "<string>",
"countryCode": "<string>",
"mobileNumber": "<string>",
"secondaryEmailIds": "<email1>,<email2>",
"schemaId": "<string>",
"status": "<string>",
"createddate": "<string>"
},
{"id": "<string>",
"givenName": "<string>",
"emailId": "<string>",
"countryCode": "<string>",
"mobileNumber": "<string>",
"secondaryEmailIds": "<email1>,<email2>",
"schemaId": "<string>",
"status": "<string>",
"createddate": "<string>"
}
]
}
}

Create Organization Users

Facilitate the addition of new users to the organization, streamlining user management and onboarding processes.

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

Example: <string>

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Request Body schema: application/json

object

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

post/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/users/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>",
"data": {"id": "<string>",
"givenName": "<string>",
"emailId": "<string>",
"countryCode": "<string>",
"mobileNumber": "<string>",
"secondaryEmailIds": "<email1>,<email2>",
"schemaId": "<string>",
"status": "<string>",
"createddate": "<string>"
}
}

Get Organization Users

Retrieve a list of all users within the organization, including their profiles and associated details.

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

Example: <string>

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Request Body schema: application/json

object

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

put/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/users/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>",
"data": {"id": "<string>",
"givenName": "<string>",
"emailId": "<string>",
"countryCode": "<string>",
"mobileNumber": "<string>",
"secondaryEmailIds": "<email1>,<email2>",
"schemaId": "<string>",
"status": "<string>",
"createddate": "<string>"
}
}

Update Organization Users

Modify user details and roles within the organization to ensure current and accurate access privileges.

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

Example: <string>

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Request Body schema: application/json

object

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

patch/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/users/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>",
"data": {"id": "<string>",
"givenName": "<string>",
"emailId": "<string>",
"countryCode": "<string>",
"mobileNumber": "<string>",
"secondaryEmailIds": "<email1>,<email2>",
"schemaId": "<string>",
"status": "<string>",
"createddate": "<string>"
}
}

Deactivate Organization Users

Deactivate users from the organization's system to maintain current and accurate user access controls.

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

Example: <string>

query Parameters

id

required

string

id of the user to delete

Example: id=<string>

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

delete/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/users/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>"
}

Delete Organization Users

Delete users within the organization

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Request Body schema: application/json

object

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

put/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/users/delete/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>"
}

Delete Organization All Users

Delete All users within the organization

SecuritybasicAuth or bearerAuth

Request

path Parameters

tenant_id

required

string

(Required)

Example: <string>

header Parameters

Content-Type	string Example: application/json
Accept	string Example: application/json

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

405

Method Not Allowed

delete/unifed-auth-service/unifed/api/v1/organization/{tenant_id}/users/delete/

Request samples

Response samples

200
400
401
403
405

application/json

{"status": "<string>",
"message": "<string>"
}