The following documentation is applicable to Free, Developer, and Developer Premium plans. For documentation related to the enterprise plan, please click here.

B2B Identity Management API

Refer this document to get API Key and Secret.

Create Organization

Creates the organization with name, Uid and display name.

Endpoint

POST https://api.loginradius.com/identity/v2/manage/organizations

Query Parameters

ParameterDefaultDescription
ApikeynoneLoginRadius API Key [Required]
ApisecretnoneLoginRadius API Secret [Required]

Body Attributes

AttributeDescription
NameName of the organization [Required]
OwnerUidUid of the owner [Required]
DisplayNameDisplay name of the organization [Opitonal]

Try Me Out

Enter query parameters and send a request to view the sample response.

Update Organization

Updates the organization for the provided organization Id.

Endpoint

PUT https://api.loginradius.com/identity/v2/manage/organizations/{id}

Query Parameters

ParameterDefaultDescription
ApikeynoneLoginRadius API Key [Required]
ApisecretnoneLoginRadius API Secret [Required]

Body Attributes

AttributeDescription
NameName of the organization [Required]
DisplayNameDisplay name of the organization [Opitonal]

Try Me Out

Enter query parameters and send a request to view the sample response.

Remove Organization

Removes the organization for the provided organization Id.

Endpoint

DELETE https://api.loginradius.com/identity/v2/manage/organizations/{id}

Query Parameters

ParameterDefaultDescription
ApikeynoneLoginRadius API Key [Required]
ApisecretnoneLoginRadius API Secret [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Organization by Id

Gets the organization by organization Id.

Endpoint

GET https://api.loginradius.com/identity/v2/manage/organizations/{id}

Query Parameters

ParameterDefaultDescription
ApikeynoneLoginRadius API Key [Required]
ApisecretnoneLoginRadius API Secret [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Organization by Organization Name

Gets the organization by organization name.

Endpoint

GET https://api.loginradius.com/identity/v2/manage/organizations/name/{org_name}

Query Parameters

ParameterDefaultDescription
ApikeynoneLoginRadius API Key [Required]
ApisecretnoneLoginRadius API Secret [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Get Organizations

Gets all organizations.

Endpoint

GET https://api.loginradius.com/identity/v2/manage/organizations

Query Parameters

ParameterDefaultDescription
ApikeynoneLoginRadius API Key [Required]
ApisecretnoneLoginRadius API Secret [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Update Status of Organization

Updates the status of an organization for the provided organization Id.

Endpoint

PUT https://api.loginradius.com/identity/v2/manage/organizations/{id}/status

Query Parameters

ParameterDefaultDescription
ApikeynoneLoginRadius API Key [Required]
ApisecretnoneLoginRadius API Secret [Required]

Body Attributes

AttributeDescription
IsActiveUpdate the status either true/false [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Add/Update Roles

Updates the organization’s default roles for the provided organization Id.

Endpoint

PUT https://api.loginradius.com/identity/v2/manage/organizations/{id}/defaultroles

Query Parameters

ParameterDefaultDescription
ApikeynoneLoginRadius API Key [Required]
ApisecretnoneLoginRadius API Secret [Required]

Body Attributes

AttributeDescription
DefaultRolesArray of Default roles which needs to be assigned to Organization Users

Try Me Out

Enter query parameters and send a request to view the sample response.

Add User to Organization

Adds users to the organization for the provided organization Id.

Endpoint

POST https://api.loginradius.com/identity/v2/manage/organizations/{id}/members

Query Parameters

ParameterDefaultDescription
ApikeynoneLoginRadius API Key [Required]
ApisecretnoneLoginRadius API Secret [Required]
emailtemplateADDUSERTOORGANIZATIONEmail Template Name [Optional]
resetPasswordUrlhttps://<AppName>.<Domain>/authURL to reset the password by the user [Optional]
loginUrlhttps://<AppName>.<Domain>/auth?org_name=<orgName>;URL to login to the organization [Optional]

Body Attributes

AttributeDescription
EmailEmail of the added User [Required]
FirstNameUser’s first name [Optional]
LastNameUser’s last name [Opitonal]

Try Me Out

Enter query parameters and send a request to view the sample response.

Organization Users

Gets organization users by organization Id.

Endpoint

GET https://api.loginradius.com/identity/v2/manage/organizations/{id}/members

Query Parameters

ParameterDefaultDescription
ApikeynoneLoginRadius API Key [Required]
ApisecretnoneLoginRadius API Secret [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Remove Users from Organization

Removes users from the organization by organization Id.

Endpoint

DELETE https://api.loginradius.com/identity/v2/manage/organizations/{id}/members

Query Parameters

ParameterDefaultDescription
ApikeynoneLoginRadius API Key [Required]
ApisecretnoneLoginRadius API Secret [Required]

Body Attributes

AttributeDescription
UIdArray of UIds [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Set Global IDP on Profile

Enables/disables the app’s authentication method for a profile by organization id and owner’s uid.

Endpoint

PUT https://api.loginradius.com/identity/v2/manage/organizations/{org_id}/members/{uid}/idp/global

Query Parameters

ParameterDefaultDescription
ApikeynoneLoginRadius API Key [Required]
ApisecretnoneLoginRadius API Secret [Required]

Body Attributes

AttributeDescription
IsEnabledStatus of the Global IDP true/false [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Set Global Authentication Method for Organization

Enables/disables the App’s authentication method for an organization for the provided organization Id.

Endpoint

PUT https://api.loginradius.com/identity/v2/manage/organizations/{org_id}/idp/global

Query Parameters

ParameterDefaultDescription
ApikeynoneLoginRadius API Key [Required]
ApisecretnoneLoginRadius API Secret [Required]

Body Attributes

AttributeDescription
IsEnabledStatus of the Global IDP true/false [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Create Organizational SAML IDP

Creates the organizational SAML IDP for the provided organization Id.

Endpoint

POST https://api.loginradius.com/identity/v2/manage/organizations/{org id}/idp/saml

Query Parameters

ParameterDefaultDescription
ApikeynoneLoginRadius API Key [Required]
ApisecretnoneLoginRadius API Secret [Required]

Body Attributes

AttributeDescription
ProviderProvider Name [Required]
ConfigSAML Configuration [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Update Organizational SAML IDP

Updates an organization’s SAML IDP for the provided organization Id and SAML Id.

Endpoint

PUT https://api.loginradius.com/identity/v2/manage/organizations/{org id}/idp/saml/{id}

Query Parameters

ParameterDefaultDescription
ApikeynoneLoginRadius API Key [Required]
ApisecretnoneLoginRadius API Secret [Required]

Body Attributes

AttributeDescription
ConfigSAML Configuration [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

All IDPs of Organization

Gets all IDPs of an organization by organization Id and IDP Id.

Endpoint

GET https://api.loginradius.com/identity/v2/manage/organizations/{org id}/idp/saml/{idpid}

Query Parameters

ParameterDefaultDescription
ApikeynoneLoginRadius API Key [Required]
ApisecretnoneLoginRadius API Secret [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

SAML IDP of Organization by Id

Gets the SAML IDP of an organization by organization Id.

Endpoint

GET https://api.loginradius.com/identity/v2/manage/organizations/{org id}/idp

Query Parameters

ParameterDefaultDescription
ApikeynoneLoginRadius API Key [Required]
ApisecretnoneLoginRadius API Secret [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Update Status of Organizational IDP

Updates the status of organizational IDP by organization Id and IDP Id.

Endpoint

PUT https://api.loginradius.com/identity/v2/manage/organizations/{org id}/idp/{id}/status

Query Parameters

ParameterDefaultDescription
ApikeynoneLoginRadius API Key [Required]
ApisecretnoneLoginRadius API Secret [Required]

Body Attributes

AttributeDescription
IsActiveStatus of the Organizational IDP - true/false [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Remove Organizational IDP

Removes the IDP of an organization by organization Id and IDP Id.

Endpoint

DELETE https://api.loginradius.com/identity/v2/manage/organizations/{org id}/idp/{id}

Query Parameters

ParameterDefaultDescription
ApikeynoneLoginRadius API Key [Required]
ApisecretnoneLoginRadius API Secret [Required]

Try Me Out

Enter query parameters and send a request to view the sample response.

Go Back to Home Page


Was this article helpful?

Have more questions? Submit a request