Update Organization connection

Updates the configuration of an Identity Provider connection.

Authorization

apikey<token>

Tenant API Key for authentication

In: query

apisecret<token>

Tenant API Secret for authentication

In: query

Path Parameters

orgId*string

Organization ID

connId*string

Organization Connection ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Name?string

Name of the connection

Domain?string

Domain associated with the connection

Attributes?

ConnectionType?string

Type of the connection, which is SAML in this case.

Value in"saml_custom" | "saml_okta" | "saml_entraid" | "saml_google_workspace" | "saml_salesforce"

IDPEntityId?string

Unique identifier for the Identity Provider (IdP).

IDPMetadataUrl?string

URL to the IdP metadata XML file.

IsIDPInitiated?boolean

Indicates whether the SAML connection is initiated by the IdP.

ConnectionType?string

Value in"oidc_custom"

AuthorizationUrl?string

The URL to the OpenID Connect provider's authorization endpoint. This is where users are redirected to authenticate and authorize access.

ClientId?string

The client identifier issued to the application by the OpenID Connect provider. This is used to identify the application during the authentication process.

ClientSecret?string

The client secret issued to the application by the OpenID Connect provider. This is used to authenticate the application when requesting tokens.

Issuer?string

The issuer identifier for the OpenID Connect provider. This is typically the base URL of the provider and is used to validate tokens.

Scopes?array<string>

The scopes requested by the application during the authentication process. Scopes define the access level and Permissions granted to the application.

TokenAuthMethod?string

The method used to authenticate the application when requesting tokens. Common methods include client_secret_post and client_secret_basic.

TokenUrl?string

The URL to the OpenID Connect provider's token endpoint. This is where the application exchanges the authorization code for tokens.

UserInfoUrl?string

The URL to the OpenID Connect provider's UserInfo endpoint.

UserInfoExtractByIdToken?|

Indicates if user info should be extracted by ID token.

JWKSEndpoint?string

The JWKS endpoint for verifying the ID token.

Name?string

Name of the connection

Domain?string

Domain associated with the connection

Attributes?

Response Body

`application/json`

curl -X PUT "https://api.loginradius.com/v2/manage/organizations/org_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef/connections/conn_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef" \  -H "Content-Type: application/json" \  -d '{}'

{
  "Id": "conn_Z5ZtmHl2aMpi5VZP",
  "IsActive": true,
  "CreatedDate": "2023-10-01T00:00:00Z",
  "GroupRoles": [
    {
      "GroupId": "eca8da89-09ed-476f-a689-11fa9a0b14ce",
      "Name": "Security",
      "RoleId": "role_Z6NE1ZkupP7lwD6E",
      "Id": "group_role_Z6NFN5kupP7lwD6G"
    }
  ],
  "ModifiedDate": "2023-10-01T00:00:00Z",
  "Name": "AzureAD",
  "Domain": "example.com",
  "Attributes": {
    "CustomMapping": {
      "Gender": "gender"
    },
    "Email": "email",
    "FirstName": "firstName",
    "Groups": "groups",
    "ID": "sub",
    "LastName": "lastName"
  },
  "IDPEntityId": "https://exampleIdp.com",
  "IDPMetadataUrl": "https://exampleIdp.com/metadata.xml",
  "IsIDPInitiated": true,
  "IDPCertificate": {
    "Certificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n",
    "NotAfter": "2023-10-01T00:00:00Z",
    "NotBefore": "2023-10-01T00:00:00Z"
  },
  "ConnectionType": "saml_custom",
  "EntityId": "https://example.hub.loginradius.com/saml/sp/Z5ZtBULhXHAJKrLsOmeWbZh5dmjKYuVWTw",
  "MetadataUrl": "https://example.hub.loginradius.com/saml/sp/Z5ZtBULhXHAJKrLsOmeWbZh5dmjKYuVWTw/metadata.xml",
  "ACSEndpoint": "https://example.hub.loginradius.com/saml/sp/acs/Z5ZtBULhXHAJKrLsOmeWbZh5dmjKYuVWTw",
  "SPCertificate": {
    "Certificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n"
  }
}

{
  "Description": "This Connection ID is invalid, please use valid Connection ID.",
  "ErrorCode": 8151,
  "Message": "Connection ID is invalid"
}

{
  "Description": "Organization domain is not verified, Please verify the domain.",
  "ErrorCode": 8177,
  "Message": "Organization domain is not verified"
}

{
  "Description": "The provided domain is not associated with the organization. Please use a different organization domain.",
  "ErrorCode": 8150,
  "Message": "Domain does not exist within the organization"
}

{
  "Description": "Connection exists with the same name. Use a different Connection name.",
  "ErrorCode": 8148,
  "Message": "Connection exists with the same name"
}

{
  "Message": "Operation failed due to an internal error.",
  "Description": "An unknown internal error occurred, please try again in a few minutes or contact your system administrator.",
  "ErrorCode": 7909
}

Update Organization connection

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

403application/json

404application/json

409application/json

500application/json

Example CONNECTION_ID_INVALID

Example CUSTOM_MAPPING_INVALID

JSON_PUT_BODY_REQUIRED_PARTNER

Example NAME_INVALID

Example OIDC_IDP_ISSUER_INVALID

Example ORGANIZATION_ID_INVALID

Example CONN_SAML_IDP_CERTIFICATE_INVALID

Example SAML_METADATA_ENDPOINT_INVALID

Example ORGANIZATION_DOMAIN_NOT_VERIFIED

ORGANIZATION_NOT_ACTIVE

Example UNAUTHORIZED_ACCESS

Example ORGANIZATION_DOMAIN_NOT_EXIST

ORGANIZATION_NOT_FOUND_PARTNER

Example CONNECTION_ALREADY_EXIST

Example CONNECTION_DOMAIN_ALREADY_EXIST

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`