Update SSOConfig

POST

https://api.luzmo.com/0.1.0/ssoconfig

API call form

Examples

SSO config allows organizations to configure Single Sign-On authentication using OIDC protocol.

The is_verified field is read-only and cannot be updated directly, It will be set to true when the SSO configuration is used successfully for the first time.

The disable_email_password field can only be set to true if the SSO configuration has been verified (is_verified is true).

Parameters

Expand all

Reset

Can be executed by:

Organization Owner

Can be associated to:

Organization

Did this page help you?

Yes

Language

Shell

Node

Java

.NET

Python

PHP

Install

npm install @luzmo/nodejs-sdk

Example Request

import Luzmo from '@luzmo/nodejs-sdk';
const client = new Luzmo({
  api_key: '<your Luzmo API key>',
  api_token: '<your Luzmo API token>',
  host: 'https://api.luzmo.com'
});


const response = await client.update('ssoconfig', '< ssoconfig ID >',
  {
    config: {
      client_id: "updated-client-id",
      client_secret: "updated-client-secret",
      issuer: "https://updated-oidc-provider.com",
      authorization_url: "https://updated-oidc-provider.com/auth",
      token_url: "https://updated-oidc-provider.com/token",
      user_info_url: "https://updated-oidc-provider.com/userinfo"
    }
  }
);

Response when an SSO configuration is updated successfully.

Example Response

200

400

500

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "organization_id": "550e8400-e29b-41d4-a716-446655440001",
  "protocol": "OIDC",
  "config": {
    "client_id": "updated-client-id",
    "client_secret": "updated-client-secret",
    "issuer": "https://updated-oidc-provider.com",
    "authorization_url": "https://updated-oidc-provider.com/auth",
    "token_url": "https://updated-oidc-provider.com/token",
    "user_info_url": "https://updated-oidc-provider.com/userinfo"
  },
  "is_verified": false,
  "disable_email_password": false,
  "created_at": "2024-01-15T10:30:00.000Z",
  "updated_at": "2024-01-15T11:45:00.000Z"
}