Skip to main content

IdentityServicesClient

Namespace: Meshmakers.Octo.Sdk.ServiceClient.IdentityServices

Implementation of the identity services client.

public class IdentityServicesClient : ServiceClient, IServiceClient, IIdentityServicesClient

Inheritance Object → ServiceClient → IdentityServicesClient
Implements IServiceClient, IIdentityServicesClient

Properties​

Options​

Returns the options for configuration of the client proxy.

public ServiceClientOptions Options { get; }

Property Value​

ServiceClientOptions

AccessToken​

public IServiceClientAccessToken AccessToken { get; }

Property Value​

IServiceClientAccessToken

ServiceUri​

public Uri ServiceUri { get; }

Property Value​

Uri

Constructors​

IdentityServicesClient(IOptions<IdentityServiceClientOptions>, IIdentityServiceClientAccessToken)​

Constructor

public IdentityServicesClient(IOptions<IdentityServiceClientOptions> serviceClientOptions, IIdentityServiceClientAccessToken identityAccessToken)

Parameters​

serviceClientOptions IOptions<IdentityServiceClientOptions>
Options for configuration of the client proxy.

identityAccessToken IIdentityServiceClientAccessToken
The access token management object

IdentityServicesClient(IdentityServiceClientOptions, IIdentityServiceClientAccessToken)​

Constructor

public IdentityServicesClient(IdentityServiceClientOptions serviceClientOptions, IIdentityServiceClientAccessToken identityAccessToken)

Parameters​

serviceClientOptions IdentityServiceClientOptions
Options for configuration of the client proxy.

identityAccessToken IIdentityServiceClientAccessToken
The access token management object

Methods​

GetIdentityProviders()​

public Task<IEnumerable<IdentityProviderDto>> GetIdentityProviders()

Returns​

Task<IEnumerable<IdentityProviderDto>>

GetIdentityProvider(OctoObjectId)​

public Task<IdentityProviderDto> GetIdentityProvider(OctoObjectId rtId)

Parameters​

rtId OctoObjectId

Returns​

Task<IdentityProviderDto>

CreateIdentityProvider(IdentityProviderDto)​

public Task CreateIdentityProvider(IdentityProviderDto identityProvider)

Parameters​

identityProvider IdentityProviderDto

Returns​

Task

UpdateIdentityProvider(OctoObjectId, IdentityProviderDto)​

public Task UpdateIdentityProvider(OctoObjectId rtId, IdentityProviderDto identityProvider)

Parameters​

rtId OctoObjectId

identityProvider IdentityProviderDto

Returns​

Task

DeleteIdentityProvider(OctoObjectId)​

public Task DeleteIdentityProvider(OctoObjectId rtId)

Parameters​

rtId OctoObjectId

Returns​

Task

GetClients()​

public Task<IEnumerable<ClientDto>> GetClients()

Returns​

Task<IEnumerable<ClientDto>>

GetClient(String)​

public Task<ClientDto> GetClient(string clientId)

Parameters​

clientId String

Returns​

Task<ClientDto>

CreateClient(ClientDto)​

public Task CreateClient(ClientDto client)

Parameters​

client ClientDto

Returns​

Task

UpdateClient(String, ClientDto)​

public Task UpdateClient(string clientId, ClientDto client)

Parameters​

clientId String

client ClientDto

Returns​

Task

DeleteClient(String)​

public Task DeleteClient(string clientId)

Parameters​

clientId String

Returns​

Task

GetUsers()​

public Task<IEnumerable<UserDto>> GetUsers()

Returns​

Task<IEnumerable<UserDto>>

GetUserByNameEmailOrId(String)​

public Task<UserDto> GetUserByNameEmailOrId(string userNameOrEMailAddress)

Parameters​

userNameOrEMailAddress String

Returns​

Task<UserDto>

AddRoleToUser(String, String)​

public Task AddRoleToUser(string userNameOrEMailAddress, string roleId)

Parameters​

userNameOrEMailAddress String

roleId String

Returns​

Task

RemoveRoleFromUser(String, String)​

public Task RemoveRoleFromUser(string userNameOrEMailAddress, string roleId)

Parameters​

userNameOrEMailAddress String

roleId String

Returns​

Task

GetClientDirectRoles(String)​

public Task<IEnumerable<string>> GetClientDirectRoles(string clientId)

Parameters​

clientId String

Returns​

Task<IEnumerable<String>>

UpdateClientRoles(String, List<String>)​

public Task UpdateClientRoles(string clientId, List<string> roleIds)

Parameters​

clientId String

roleIds List<String>

Returns​

Task

AddRoleToClient(String, String)​

public Task AddRoleToClient(string clientId, string roleName)

Parameters​

clientId String

roleName String

Returns​

Task

RemoveRoleFromClient(String, String)​

public Task RemoveRoleFromClient(string clientId, string roleName)

Parameters​

clientId String

roleName String

Returns​

Task

CreateUser(UserDto)​

public Task CreateUser(UserDto userDto)

Parameters​

userDto UserDto

Returns​

Task

UpdateUser(String, UserDto)​

public Task UpdateUser(string userName, UserDto userDto)

Parameters​

userName String

userDto UserDto

Returns​

Task

DeleteUser(String)​

public Task DeleteUser(string userName)

Parameters​

userName String

Returns​

Task

ResetPassword(String, String)​

public Task ResetPassword(string userName, string password)

Parameters​

userName String

password String

Returns​

Task

GetRoleByName(String)​

public Task<RoleDto> GetRoleByName(string roleName)

Parameters​

roleName String

Returns​

Task<RoleDto>

GetRoles()​

public Task<IEnumerable<RoleDto>> GetRoles()

Returns​

Task<IEnumerable<RoleDto>>

CreateRole(RoleDto)​

public Task CreateRole(RoleDto roleDto)

Parameters​

roleDto RoleDto

Returns​

Task

UpdateRole(String, RoleDto)​

public Task UpdateRole(string roleName, RoleDto roleDto)

Parameters​

roleName String

roleDto RoleDto

Returns​

Task

DeleteRole(String)​

public Task DeleteRole(string roleName)

Parameters​

roleName String

Returns​

Task

GetApiScopes()​

public Task<IEnumerable<ApiScopeDto>> GetApiScopes()

Returns​

Task<IEnumerable<ApiScopeDto>>

GetApiScope(String)​

public Task<ApiScopeDto> GetApiScope(string name)

Parameters​

name String

Returns​

Task<ApiScopeDto>

DeleteScope(String)​

public Task DeleteScope(string name)

Parameters​

name String

Returns​

Task

UpdateApiScope(String, ApiScopeDto)​

public Task UpdateApiScope(string name, ApiScopeDto scopeDto)

Parameters​

name String

scopeDto ApiScopeDto

Returns​

Task

CreateApiScope(ApiScopeDto)​

public Task CreateApiScope(ApiScopeDto apiScopeDto)

Parameters​

apiScopeDto ApiScopeDto

Returns​

Task

DeleteApiSecretClient(String, String)​

public Task DeleteApiSecretClient(string clientId, string secretValue)

Parameters​

clientId String

secretValue String

Returns​

Task

DeleteApiSecretApiResource(String, String)​

public Task DeleteApiSecretApiResource(string apiResourceName, string secretValue)

Parameters​

apiResourceName String

secretValue String

Returns​

Task

GetApiSecretsForClient(String)​

public Task<IEnumerable<ApiSecretDto>> GetApiSecretsForClient(string clientId)

Parameters​

clientId String

Returns​

Task<IEnumerable<ApiSecretDto>>

GetApiSecretForClient(String, String)​

public Task<ApiSecretDto> GetApiSecretForClient(string clientId, string secretValue)

Parameters​

clientId String

secretValue String

Returns​

Task<ApiSecretDto>

GetApiSecretsForApiResource(String)​

public Task<IEnumerable<ApiSecretDto>> GetApiSecretsForApiResource(string apiResourceName)

Parameters​

apiResourceName String

Returns​

Task<IEnumerable<ApiSecretDto>>

GetApiSecretForApiResource(String, String)​

public Task<ApiSecretDto> GetApiSecretForApiResource(string apiResourceName, string secretValue)

Parameters​

apiResourceName String

secretValue String

Returns​

Task<ApiSecretDto>

CreateApiSecretForClient(String, ApiSecretDto)​

public Task<ApiSecretDto> CreateApiSecretForClient(string clientId, ApiSecretDto apiSecretDto)

Parameters​

clientId String

apiSecretDto ApiSecretDto

Returns​

Task<ApiSecretDto>

CreateApiSecretForApiResource(String, ApiSecretDto)​

public Task<ApiSecretDto> CreateApiSecretForApiResource(string apiResourceName, ApiSecretDto apiSecretDto)

Parameters​

apiResourceName String

apiSecretDto ApiSecretDto

Returns​

Task<ApiSecretDto>

UpdateApiSecretClient(String, ApiSecretDto)​

public Task UpdateApiSecretClient(string clientId, ApiSecretDto apiSecretDto)

Parameters​

clientId String

apiSecretDto ApiSecretDto

Returns​

Task

UpdateApiSecretApiResource(String, ApiSecretDto)​

public Task UpdateApiSecretApiResource(string apiResourceName, ApiSecretDto apiSecretDto)

Parameters​

apiResourceName String

apiSecretDto ApiSecretDto

Returns​

Task

GetApiResources()​

public Task<List<ApiResourceDto>> GetApiResources()

Returns​

Task<List<ApiResourceDto>>

CreateApiResource(ApiResourceDto)​

public Task CreateApiResource(ApiResourceDto apiResourceDto)

Parameters​

apiResourceDto ApiResourceDto

Returns​

Task

DeleteApiResource(String)​

public Task DeleteApiResource(string name)

Parameters​

name String

Returns​

Task

UpdateApiResource(String, ApiResourceDto)​

public Task UpdateApiResource(string name, ApiResourceDto apiResourceDto)

Parameters​

name String

apiResourceDto ApiResourceDto

Returns​

Task

GetEmailDomainGroupRules()​

public Task<IEnumerable<EmailDomainGroupRuleDto>> GetEmailDomainGroupRules()

Returns​

Task<IEnumerable<EmailDomainGroupRuleDto>>

GetEmailDomainGroupRule(OctoObjectId)​

public Task<EmailDomainGroupRuleDto> GetEmailDomainGroupRule(OctoObjectId rtId)

Parameters​

rtId OctoObjectId

Returns​

Task<EmailDomainGroupRuleDto>

CreateEmailDomainGroupRule(EmailDomainGroupRuleDto)​

public Task CreateEmailDomainGroupRule(EmailDomainGroupRuleDto rule)

Parameters​

rule EmailDomainGroupRuleDto

Returns​

Task

UpdateEmailDomainGroupRule(OctoObjectId, EmailDomainGroupRuleDto)​

public Task UpdateEmailDomainGroupRule(OctoObjectId rtId, EmailDomainGroupRuleDto rule)

Parameters​

rtId OctoObjectId

rule EmailDomainGroupRuleDto

Returns​

Task

DeleteEmailDomainGroupRule(OctoObjectId)​

public Task DeleteEmailDomainGroupRule(OctoObjectId rtId)

Parameters​

rtId OctoObjectId

Returns​

Task

GetGroups()​

public Task<IEnumerable<GroupDto>> GetGroups()

Returns​

Task<IEnumerable<GroupDto>>

GetGroup(OctoObjectId)​

public Task<GroupDto> GetGroup(OctoObjectId rtId)

Parameters​

rtId OctoObjectId

Returns​

Task<GroupDto>

GetGroupByName(String)​

public Task<GroupDto> GetGroupByName(string name)

Parameters​

name String

Returns​

Task<GroupDto>

CreateGroup(CreateGroupDto)​

public Task CreateGroup(CreateGroupDto group)

Parameters​

group CreateGroupDto

Returns​

Task

UpdateGroup(OctoObjectId, UpdateGroupDto)​

public Task UpdateGroup(OctoObjectId rtId, UpdateGroupDto group)

Parameters​

rtId OctoObjectId

group UpdateGroupDto

Returns​

Task

DeleteGroup(OctoObjectId)​

public Task DeleteGroup(OctoObjectId rtId)

Parameters​

rtId OctoObjectId

Returns​

Task

UpdateGroupRoles(OctoObjectId, List<String>)​

public Task UpdateGroupRoles(OctoObjectId rtId, List<string> roleIds)

Parameters​

rtId OctoObjectId

roleIds List<String>

Returns​

Task

AddUserToGroup(OctoObjectId, String)​

public Task AddUserToGroup(OctoObjectId rtId, string userId)

Parameters​

rtId OctoObjectId

userId String

Returns​

Task

RemoveUserFromGroup(OctoObjectId, String)​

public Task RemoveUserFromGroup(OctoObjectId rtId, string userId)

Parameters​

rtId OctoObjectId

userId String

Returns​

Task

AddClientToGroup(OctoObjectId, String)​

public Task AddClientToGroup(OctoObjectId rtId, string clientId)

Parameters​

rtId OctoObjectId

clientId String

Returns​

Task

RemoveClientFromGroup(OctoObjectId, String)​

public Task RemoveClientFromGroup(OctoObjectId rtId, string clientId)

Parameters​

rtId OctoObjectId

clientId String

Returns​

Task

AddGroupToGroup(OctoObjectId, String)​

public Task AddGroupToGroup(OctoObjectId rtId, string childGroupId)

Parameters​

rtId OctoObjectId

childGroupId String

Returns​

Task

RemoveGroupFromGroup(OctoObjectId, String)​

public Task RemoveGroupFromGroup(OctoObjectId rtId, string childGroupId)

Parameters​

rtId OctoObjectId

childGroupId String

Returns​

Task

GetExternalTenantUserMappings(Nullable<Int32>, Nullable<Int32>, String)​

public Task<IEnumerable<ExternalTenantUserMappingDto>> GetExternalTenantUserMappings(Nullable<int> skip, Nullable<int> take, string sourceTenantId)

Parameters​

skip Nullable<Int32>

take Nullable<Int32>

sourceTenantId String

Returns​

Task<IEnumerable<ExternalTenantUserMappingDto>>

GetExternalTenantUserMapping(OctoObjectId)​

public Task<ExternalTenantUserMappingDto> GetExternalTenantUserMapping(OctoObjectId rtId)

Parameters​

rtId OctoObjectId

Returns​

Task<ExternalTenantUserMappingDto>

CreateExternalTenantUserMapping(CreateExternalTenantUserMappingDto)​

public Task CreateExternalTenantUserMapping(CreateExternalTenantUserMappingDto mapping)

Parameters​

mapping CreateExternalTenantUserMappingDto

Returns​

Task

UpdateExternalTenantUserMapping(OctoObjectId, UpdateExternalTenantUserMappingDto)​

public Task UpdateExternalTenantUserMapping(OctoObjectId rtId, UpdateExternalTenantUserMappingDto mapping)

Parameters​

rtId OctoObjectId

mapping UpdateExternalTenantUserMappingDto

Returns​

Task

DeleteExternalTenantUserMapping(OctoObjectId)​

public Task DeleteExternalTenantUserMapping(OctoObjectId rtId)

Parameters​

rtId OctoObjectId

Returns​

Task

GetAdminProvisioningMappings(String)​

public Task<IEnumerable<ExternalTenantUserMappingDto>> GetAdminProvisioningMappings(string targetTenantId)

Parameters​

targetTenantId String

Returns​

Task<IEnumerable<ExternalTenantUserMappingDto>>

CreateAdminProvisioningMapping(String, CreateExternalTenantUserMappingDto)​

public Task CreateAdminProvisioningMapping(string targetTenantId, CreateExternalTenantUserMappingDto mapping)

Parameters​

targetTenantId String

mapping CreateExternalTenantUserMappingDto

Returns​

Task

ProvisionCurrentUser(String)​

public Task ProvisionCurrentUser(string targetTenantId)

Parameters​

targetTenantId String

Returns​

Task

DeleteAdminProvisioningMapping(String, OctoObjectId)​

public Task DeleteAdminProvisioningMapping(string targetTenantId, OctoObjectId mappingRtId)

Parameters​

targetTenantId String

mappingRtId OctoObjectId

Returns​

Task

ReconfigureLogLevelAsync(String, LogLevelDto, LogLevelDto)​

public Task ReconfigureLogLevelAsync(string loggerName, LogLevelDto minLogLevel, LogLevelDto maxLogLevel)

Parameters​

loggerName String

minLogLevel LogLevelDto

maxLogLevel LogLevelDto

Returns​

Task

GetClientMirrors(String)​

public Task<IEnumerable<ClientMirrorDto>> GetClientMirrors(string clientId)

Parameters​

clientId String

Returns​

Task<IEnumerable<ClientMirrorDto>>

ProvisionClientInExistingTenants(String)​

public Task<ClientMirrorBackfillResponseDto> ProvisionClientInExistingTenants(string clientId)

Parameters​

clientId String

Returns​

Task<ClientMirrorBackfillResponseDto>

ProvisionClientInTenant(String, String)​

public Task<ClientMirrorProvisionResponseDto> ProvisionClientInTenant(string clientId, string childTenantId)

Parameters​

clientId String

childTenantId String

Returns​

Task<ClientMirrorProvisionResponseDto>

UnprovisionClientFromTenant(String, String)​

public Task UnprovisionClientFromTenant(string clientId, string childTenantId)

Parameters​

clientId String

childTenantId String

Returns​

Task

SetClientAutoProvisionInChildTenants(String, Boolean)​

public Task SetClientAutoProvisionInChildTenants(string clientId, bool enabled)

Parameters​

clientId String

enabled Boolean

Returns​

Task

ApplyClientOverlay(String, ApplyOverlayUrisDto)​

public Task<ApplyOverlayUrisResultDto> ApplyClientOverlay(string clientId, ApplyOverlayUrisDto dto)

Parameters​

clientId String

dto ApplyOverlayUrisDto

Returns​

Task<ApplyOverlayUrisResultDto>

CleanOverlayEntries(String)​

public Task<CleanOverlayEntriesResultDto> CleanOverlayEntries(string overlayName)

Parameters​

overlayName String

Returns​

Task<CleanOverlayEntriesResultDto>

BuildServiceUri()​

protected Uri BuildServiceUri()

Returns​

Uri

GetDataPermissions()​

public Task<IEnumerable<DataPermissionDto>> GetDataPermissions()

Returns​

Task<IEnumerable<DataPermissionDto>>

CreateDataPermission(DataPermissionDto)​

public Task CreateDataPermission(DataPermissionDto dataPermission)

Parameters​

dataPermission DataPermissionDto

Returns​

Task

DeleteDataPermission(String)​

public Task DeleteDataPermission(string permissionId)

Parameters​

permissionId String

Returns​

Task

CreateDataPolicy(String, DataPolicyDto)​

public Task<string> CreateDataPolicy(string permissionId, DataPolicyDto dataPolicy)

Parameters​

permissionId String

dataPolicy DataPolicyDto

Returns​

Task<String>

DeleteDataPolicy(String)​

public Task DeleteDataPolicy(string policyRtId)

Parameters​

policyRtId String

Returns​

Task

SetDataPolicyEnforcementMode(String, String)​

public Task SetDataPolicyEnforcementMode(string policyRtId, string enforcementMode)

Parameters​

policyRtId String

enforcementMode String

Returns​

Task

GrantDataPermissionToRole(String, String)​

public Task GrantDataPermissionToRole(string permissionId, string roleName)

Parameters​

permissionId String

roleName String

Returns​

Task

RevokeDataPermissionFromRole(String, String)​

public Task RevokeDataPermissionFromRole(string permissionId, string roleName)

Parameters​

permissionId String

roleName String

Returns​

Task