Auth Modules

Create auth module

post /api/http/auth-modules

Create a new authentication module. Settings are specific to the type of authentication module being created.

Required permissions: Manage authentication modules

Request arguments

object with fields:

key: string ( Required )
name: string ( Required )
enabled: boolean ( Required )
iconDataURI: string ( Nullable and Optional , defaults to null)
settings: ES_AuthModuleSettings ( Required )

Response
`ES_AuthModule`

Get all auth modules

get /api/http/auth-modules

Get all authentication modules

Request arguments
`withDisabled`: `boolean` (Query) ( Optional , defaults to `false`)

Response
array of `ES_AuthModule`

Reorder authentication modules

post /api/http/auth-modules/reorder

Define the order of authentication modules. This affects the order of the federated authentication module buttons on the sign-in page.

Required permissions: Manage authentication modules

Request arguments

object with fields:

order: array of string ( Required )

Response
No arguments

Saml metadata

post /api/http/auth-modules/{id}/saml-metadata

Request arguments

id: string (Path) ( Required )

object with fields:

idpUrl: string ( Required )
idpEntityId: string ( Required )
idpCertificateSHA256: string ( Required )
spEntityId: string ( Required )
sslKeystore: SSLKeystore ( Nullable and Optional , defaults to null)
contactProfileId: string ( Nullable and Optional , defaults to null)

Response
`SamlMetadataResponse`

Discover oidc

get /api/http/auth-modules/discover-oidc

Automatically discovers the endpoints for the OpenID Connect provider via discovery document

Required permissions: Manage authentication modules

Request arguments
`discoveryEndpoint`: `string` (Query) ( Required )

Response
`OIDCDiscovery`

Get auth module by key

get /api/http/auth-modules/key:{key}

Get an existing authentication module

Request arguments
`key`: `string` (Path) ( Required )

Response
`ES_AuthModule`

Update auth module

patch /api/http/auth-modules/{id}

Update an existing authentication module. Optional parameters will be ignored when not specified and updated otherwise.

Required permissions: Manage authentication modules

Request arguments

id: string (Path) ( Required )

object with fields:

key: string ( Nullable and Optional , defaults to null)
name: string ( Nullable and Optional , defaults to null)
enabled: boolean ( Nullable and Optional , defaults to null)
iconDataURI: string ( Nullable and Optional )
settings: ES_AuthModuleSettings ( Nullable and Optional , defaults to null)

Response
No arguments

Delete auth module

delete /api/http/auth-modules/{id}

Delete an existing authentication module

Required permissions: Manage authentication modules

Request arguments
`id`: `string` (Path) ( Required )

Response
No arguments

Get config

get /api/http/auth-modules/config

Get authentication configuration

Required permissions: Manage authentication modules

Request arguments
No arguments

Response
`AuthConfig`

Put config

put /api/http/auth-modules/config

Set authentication configuration

Required permissions: Manage authentication modules

Request arguments

object with fields:

dontRememberMeTtl: integer (format: int32) ( Nullable and Optional , defaults to null)
adminRememberMeTtl: integer (format: int32) ( Nullable and Optional , defaults to null)
userRememberMeTtl: integer (format: int32) ( Nullable and Optional , defaults to null)

Response
No arguments

Delete config

delete /api/http/auth-modules/config

Reset authentication configuration to default

Required permissions: Manage authentication modules

Request arguments
No arguments

Response
`AuthConfig`

Test built-in settings

post /api/http/auth-modules/test/built-in

For a username/password combination, test built-in authentication with updated settings

Request arguments

object with fields:

settings: ES_BuiltinAuthModuleSettings ( Required )
username: string ( Required )
password: string ( Required )

Response
`TD_MemberProfile`

Test ldap settings

post /api/http/auth-modules/test/ldap

For a username/password combination, test LDAP authentication with updated settings

Request arguments

object with fields:

settings: ES_LdapAuthModuleSettings ( Required )
username: string ( Required )
password: string ( Required )

Response
`ES_DefaultProfileLoginDetails`

Get throttled logins

get /api/http/auth-modules/throttled-logins

Returns logins that are currently subjected to rate limits when logging in to Space

Request arguments
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`login`: `string` (Query) ( Nullable and Optional , defaults to `null`)

Response

object with fields:

next: string ( Required )
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of ThrottledLogin ( Required )

Reset throttling status

delete /api/http/auth-modules/throttled-logins

Resets the counter that tracks failed login attempts for the account with the specified logins. The member who use these accounts are no longer blocked from attempting to log in to Space.

Request arguments
`logins`: array of `string` (Query) ( Required )

Response
No arguments

Get organization throttling status

get /api/http/auth-modules/throttled-logins/org-status

Returns date and time until which the organization are throttled

Request arguments
No arguments

Response
`OrgThrottlingStatus`

Reset organization throttling

delete /api/http/auth-modules/throttled-logins/org-status

Resets date and time until which the organization are throttled

Request arguments
No arguments

Response
No arguments

Get all usages

get /api/http/auth-modules/usages

Retrieve a list of authentication module usage count

Required permissions: Manage authentication modules

Request arguments
No arguments

Response
array of `AuthModuleUsage`

Change password

post /api/http/auth-modules/{id}/logins/{identifier}/change

Change password for a given authentication module ( id ) and profile ( identifier )

Request arguments

id: string (Path) ( Required )

identifier: string (Path) ( Required )

object with fields:

oldPassword: string ( Required )
newPassword: string ( Required )

Response
No arguments

Reset password

post /api/http/auth-modules/{id}/logins/{identifier}/reset

Request a password reset for a given authentication module ( id ) and profile ( identifier )

Request arguments
`id`: `string` (Path) ( Required )
`identifier`: `string` (Path) ( Required )

Response
No arguments

Delete login

delete /api/http/auth-modules/{id}/logins/{identifier}

Detach a profile login from an authentication module. The id parameter refers to the authentication module, the identifier parameter refers to the login.

Request arguments
`identifier`: `string` (Path) ( Required )
`id`: `string` (Path) ( Required )

Response
No arguments

Last modified: 06 September 2023