ExternalLoginProvider

[GET] /api/v1/externalloginproviders

Get all external login providers.

Responses

[200] Success

[PUT] /api/v1/externalloginproviders/{name}

Parameters

Name	In	Type	Description
nameRequired	path	string	The name of the specified external login provider.

Update the specified external login provider's information.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

ExternalLoginProviderModel

Responses

[200] Success

[POST] /api/v1/externalloginproviders/{name}/sync

Parameters

Name	In	Type
nameRequired	path	string

Syncing the specified external login provider's users, roles, and organizations.

Responses

[200] Success

[GET] /api/v1/externalloginproviders/{name}/tenants

Parameters

Name	In	Type
nameRequired	path	string

Get the specified external login provider's tenants.

Responses

[200] Success

[GET] /api/v1/externalloginproviders/{name}/organizations

Parameters

Name	In	Type
nameRequired	path	string

Get the specified external login provider's tenants.

Responses

[200] Success

[GET] /api/v1/externalloginproviders/{name}/roles

Parameters

Name	In	Type
nameRequired	path	string

Get the specified external login provider's roles.

Responses

[200] Success

[GET] /api/v1/externalloginproviders/{name}/users

Parameters

Name	In	Type
nameRequired	path	string

Get the specified external login provider's users.

Responses

[200] Success

[GET] /api/v1/externalloginproviders/message-enabled

Get all the external login providers which enables sending messages.

Responses

[200] Success

[POST] /api/v1/externalloginproviders/{name}/message

Parameters

Name	In	Type
nameRequired	path	string

Send message to specified external login provider.

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

ExternalMessage

Responses

[200] Success

Models

Ƭ ExternalLoginProviderModel

Name	Type
providerNameNullable	string
descriptionNullable	string
dataSyncingTimeNullable	ISO DateTime Sting
settingsNullable	Array<ConfigurationItem>

Ƭ ConfigurationItem

Name	Type
nameNullable	string
displayNameNullable	string
descriptionNullable	string
valueType	ConfigurationItemValueType
valueNullable	any
restriction	ConfigurationItemRestriction

Ƭ ConfigurationItemValueType

Enum:

• Text
• Boolean
• Number
• Password

Ƭ ConfigurationItemRestriction

Enum:

• Mandatory
• Optional

Ƭ ExternalMessage

Name	Type
subjectNullable	string
recipients	MessageRecipients
contentNullable	string
urlNullable	string

Ƭ MessageRecipients

Name	Type
usersNullable	Array<string>
organizationsNullable	Array<string>
rolesNullable	Array<string>
allUsers	Boolean