UserIdentityProviderService (Cyclos 4.16.19 Scripting API Documentation)

All Superinterfaces:

Service

All Known Subinterfaces:

UserIdentityProviderServiceLocal
```
public interface UserIdentityProviderService
extends Service
```
Manages the link between users and identity providers

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`disable(UserLocatorVO user, IdentityProviderVO provider)`	Marks the given identity provider as disabled for the user.
`UserIdentityProviderListData`	`getListData(UserLocatorVO user)`	Returns data with the current identity provider links, as well as related permissions.
`void`	`unlink(UserLocatorVO user, IdentityProviderVO provider)`	Removes the link between the user and the given provider.

- Method Detail
  - disable
```
void disable(UserLocatorVO user,
             IdentityProviderVO provider)
      throws FrameworkException
```
    Marks the given identity provider as disabled for the user. This means the provider cannot be used again for this user until it is marked as unlinked or manually linked again.
    
    Throws:
    
    FrameworkException
  - getListData
```
UserIdentityProviderListData getListData(UserLocatorVO user)
                                  throws FrameworkException
```
    Returns data with the current identity provider links, as well as related permissions.
    
    Throws:
    
    FrameworkException
  - unlink
```
void unlink(UserLocatorVO user,
            IdentityProviderVO provider)
     throws FrameworkException
```
    Removes the link between the user and the given provider. No-op if the relation doesn't exist.
    
    Throws:
    
    FrameworkException