IIdentityServicesClient
Namespace: Meshmakers.Octo.Sdk.ServiceClient.IdentityServices
Interface for the identity services.
public interface IIdentityServicesClient : IServiceClient
Implements IServiceClient
Methods
GetIdentityProviders()
Returns the identity providers.
Task<IEnumerable<IdentityProviderDto>> GetIdentityProviders()
Returns
Task<IEnumerable<IdentityProviderDto>>
GetIdentityProvider(OctoObjectId)
Gets an identity provider by id.
Task<IdentityProviderDto> GetIdentityProvider(OctoObjectId rtId)
Parameters
rtId OctoObjectId
The identifier of the identity provider
Returns
CreateIdentityProvider(IdentityProviderDto)
Creates an identity provider.
Task CreateIdentityProvider(IdentityProviderDto identityProvider)
Parameters
identityProvider IdentityProviderDto
The identity provider data transfer object
Returns
UpdateIdentityProvider(OctoObjectId, IdentityProviderDto)
Updates an identity provider.
Task UpdateIdentityProvider(OctoObjectId rtId, IdentityProviderDto identityProvider)
Parameters
rtId OctoObjectId
The identifier of the identity provider
identityProvider IdentityProviderDto
The identity provider data transfer object
Returns
DeleteIdentityProvider(OctoObjectId)
Delete an identity provider.
Task DeleteIdentityProvider(OctoObjectId rtId)
Parameters
rtId OctoObjectId
The identifier of the identity provider
Returns
GetClients()
Gets a list of clients.
Task<IEnumerable<ClientDto>> GetClients()
Returns
GetClient(String)
Gets a client by id.
Task<ClientDto> GetClient(string clientId)
Parameters
clientId String
The identifier of the client
Returns
CreateClient(ClientDto)
Creates a client.
Task CreateClient(ClientDto client)
Parameters
client ClientDto
The client data transfer object
Returns
UpdateClient(String, ClientDto)
Updates a client.
Task UpdateClient(string clientId, ClientDto client)
Parameters
clientId String
The identifier of the client
client ClientDto
The client data transfer object
Returns
DeleteClient(String)
Deletes a client.
Task DeleteClient(string clientId)
Parameters
clientId String
The identifier of the client
Returns
GetUsers()
Gets a list of users.
Task<IEnumerable<UserDto>> GetUsers()
Returns
GetUserByNameEmailOrId(String)
Gets a user by name or email.
Task<UserDto> GetUserByNameEmailOrId(string userNameOrEMailAddress)
Parameters
userNameOrEMailAddress String
User name or e-mail of user
Returns
CreateUser(UserDto)
Creates a user.
Task CreateUser(UserDto userDto)
Parameters
userDto UserDto
User data transfer object
Returns
UpdateUser(String, UserDto)
Updates a user.
Task UpdateUser(string userNameOrEMailAddress, UserDto userDto)
Parameters
userNameOrEMailAddress String
User name or e-mail of user
userDto UserDto
User data transfer object
Returns
DeleteUser(String)
Deletes a user.
Task DeleteUser(string userNameOrEMailAddress)
Parameters
userNameOrEMailAddress String
User name or e-mail of user
Returns
ResetPassword(String, String)
Resets the password of a user.
Task ResetPassword(string userNameOrEMailAddress, string password)
Parameters
userNameOrEMailAddress String
User name or e-mail of user
password String
New password
Returns
GetRoleByName(String)
Gets a role by name.
Task<RoleDto> GetRoleByName(string roleName)
Parameters
roleName String
Name of role
Returns
GetRoles()
Get a list of roles.
Task<IEnumerable<RoleDto>> GetRoles()
Returns
CreateRole(RoleDto)
Creates a role
Task CreateRole(RoleDto roleDto)
Parameters
roleDto RoleDto
Role data transfer object
Returns
UpdateRole(String, RoleDto)
Updates a role.
Task UpdateRole(string roleName, RoleDto roleDto)
Parameters
roleName String
Name of role
roleDto RoleDto
Role data transfer object
Returns
DeleteRole(String)
Deletes a role.
Task DeleteRole(string roleName)
Parameters
roleName String
Name of role
Returns
GetApiScopes()
Gets a list of scopes
Task<IEnumerable<ApiScopeDto>> GetApiScopes()
Returns
Task<IEnumerable<ApiScopeDto>>
GetApiScope(String)
Gets an api scope by name.
Task<ApiScopeDto> GetApiScope(string name)
Parameters
name String
Name of scope
Returns
DeleteScope(String)
Deletes a scope.
Task DeleteScope(string name)
Parameters
name String
Name of scope
Returns
UpdateApiScope(String, ApiScopeDto)
Updates a scope
Task UpdateApiScope(string name, ApiScopeDto scopeDto)
Parameters
name String
Name of scope
scopeDto ApiScopeDto
Scope data transfer object
Returns
CreateApiScope(ApiScopeDto)
Creates a scope.
Task CreateApiScope(ApiScopeDto apiScopeDto)
Parameters
apiScopeDto ApiScopeDto
Scope data transfer object
Returns
DeleteApiSecretClient(String, String)
Deletes an api secret of a client.
Task DeleteApiSecretClient(string clientId, string secretValue)
Parameters
clientId String
The client id of the secret
secretValue String
The secret value
Returns
DeleteApiSecretApiResource(String, String)
Deletes an api secret of a api resource.
Task DeleteApiSecretApiResource(string apiResourceName, string secretValue)
Parameters
apiResourceName String
The name of the API resource
secretValue String
The secret value
Returns
GetApiSecretsForClient(String)
Gets a list of api secrets for a client.
Task<IEnumerable<ApiSecretDto>> GetApiSecretsForClient(string clientId)
Parameters
clientId String
Returns
Task<IEnumerable<ApiSecretDto>>
GetApiSecretForClient(String, String)
Gets a api secret for a client.
Task<ApiSecretDto> GetApiSecretForClient(string clientId, string secretValue)
Parameters
clientId String
The identifier of the client
secretValue String
The secret value
Returns
GetApiSecretsForApiResource(String)
Gets a list of api secrets for a api resource.
Task<IEnumerable<ApiSecretDto>> GetApiSecretsForApiResource(string apiResourceName)
Parameters
apiResourceName String
Name of API resource
Returns
Task<IEnumerable<ApiSecretDto>>
GetApiSecretForApiResource(String, String)
Gets a api secret for a api resource.
Task<ApiSecretDto> GetApiSecretForApiResource(string apiResourceName, string secretValue)
Parameters
apiResourceName String
Name of API resource
secretValue String
The secret value
Returns
CreateApiSecretForClient(String, ApiSecretDto)
Creates an api secret for a client.
Task<ApiSecretDto> CreateApiSecretForClient(string clientId, ApiSecretDto apiSecretDto)
Parameters
clientId String
The client id
apiSecretDto ApiSecretDto
The API secret data transfer object
Returns
CreateApiSecretForApiResource(String, ApiSecretDto)
Creates an api secret for a api resource.
Task<ApiSecretDto> CreateApiSecretForApiResource(string apiResourceName, ApiSecretDto apiSecretDto)
Parameters
apiResourceName String
Name of API resource
apiSecretDto ApiSecretDto
The secret data transfer object
Returns
UpdateApiSecretClient(String, ApiSecretDto)
Updates an api secret of a client.
Task UpdateApiSecretClient(string clientId, ApiSecretDto apiSecretDto)
Parameters
clientId String
The client id
apiSecretDto ApiSecretDto
The secret data transfer object
Returns
UpdateApiSecretApiResource(String, ApiSecretDto)
Updates an api secret of a api resource.
Task UpdateApiSecretApiResource(string apiResourceName, ApiSecretDto apiSecretDto)
Parameters
apiResourceName String
Name of API resource
apiSecretDto ApiSecretDto
API secret data transfer object
Returns
AddRoleToUser(String, String)
Adds a role to a user.
Task AddRoleToUser(string userNameOrEMailAddress, string roleId)
Parameters
userNameOrEMailAddress String
User name or E-Mail address of the user
roleId String
The id of the role
Returns
RemoveRoleFromUser(String, String)
Removes a role from a user.
Task RemoveRoleFromUser(string userNameOrEMailAddress, string roleId)
Parameters
userNameOrEMailAddress String
User name or E-Mail address of the user
roleId String
The id of the role
Returns
GetClientDirectRoles(String)
Gets the role IDs directly assigned to a client (excluding group-inherited roles).
Task<IEnumerable<string>> GetClientDirectRoles(string clientId)
Parameters
clientId String
The client id
Returns
Task<IEnumerable<String>>
The directly-assigned role IDs.
UpdateClientRoles(String, List<String>)
Replaces the directly-assigned roles of a client with the given role IDs (replace-all).
Task UpdateClientRoles(string clientId, List<string> roleIds)
Parameters
clientId String
The client id
roleIds List<String>
The full target list of role IDs
Returns
AddRoleToClient(String, String)
Assigns a single role (by name) to a client.
Task AddRoleToClient(string clientId, string roleName)
Parameters
clientId String
The client id
roleName String
The role name
Returns
RemoveRoleFromClient(String, String)
Removes a single role (by name) from a client.
Task RemoveRoleFromClient(string clientId, string roleName)
Parameters
clientId String
The client id
roleName String
The role name
Returns
GetApiResources()
Gets a list of API resources.
Task<List<ApiResourceDto>> GetApiResources()
Returns
CreateApiResource(ApiResourceDto)
Creates an API resource.
Task CreateApiResource(ApiResourceDto apiResourceDto)
Parameters
apiResourceDto ApiResourceDto
API resource data transfer object
Returns
DeleteApiResource(String)
Deletes an API resource.
Task DeleteApiResource(string name)
Parameters
name String
Name of API resource
Returns
UpdateApiResource(String, ApiResourceDto)
Updates an API resource.
Task UpdateApiResource(string name, ApiResourceDto apiResourceDto)
Parameters
name String
Name of API resource
apiResourceDto ApiResourceDto
API resource data transfer object
Returns
GetEmailDomainGroupRules()
Gets all email domain group rules.
Task<IEnumerable<EmailDomainGroupRuleDto>> GetEmailDomainGroupRules()
Returns
Task<IEnumerable<EmailDomainGroupRuleDto>>
GetEmailDomainGroupRule(OctoObjectId)
Gets an email domain group rule by id.
Task<EmailDomainGroupRuleDto> GetEmailDomainGroupRule(OctoObjectId rtId)
Parameters
rtId OctoObjectId
The identifier of the rule
Returns
CreateEmailDomainGroupRule(EmailDomainGroupRuleDto)
Creates an email domain group rule.
Task CreateEmailDomainGroupRule(EmailDomainGroupRuleDto rule)
Parameters
rule EmailDomainGroupRuleDto
The rule data transfer object
Returns
UpdateEmailDomainGroupRule(OctoObjectId, EmailDomainGroupRuleDto)
Updates an email domain group rule.
Task UpdateEmailDomainGroupRule(OctoObjectId rtId, EmailDomainGroupRuleDto rule)
Parameters
rtId OctoObjectId
The identifier of the rule
rule EmailDomainGroupRuleDto
The rule data transfer object
Returns
DeleteEmailDomainGroupRule(OctoObjectId)
Deletes an email domain group rule.
Task DeleteEmailDomainGroupRule(OctoObjectId rtId)
Parameters
rtId OctoObjectId
The identifier of the rule
Returns
GetGroups()
Gets all groups.
Task<IEnumerable<GroupDto>> GetGroups()
Returns
GetGroup(OctoObjectId)
Gets a group by id.
Task<GroupDto> GetGroup(OctoObjectId rtId)
Parameters
rtId OctoObjectId
The identifier of the group
Returns
GetGroupByName(String)
Gets a group by name.
Task<GroupDto> GetGroupByName(string name)
Parameters
name String
The name of the group
Returns
CreateGroup(CreateGroupDto)
Creates a group.
Task CreateGroup(CreateGroupDto group)
Parameters
group CreateGroupDto
The group data transfer object
Returns
UpdateGroup(OctoObjectId, UpdateGroupDto)
Updates a group.
Task UpdateGroup(OctoObjectId rtId, UpdateGroupDto group)
Parameters
rtId OctoObjectId
The identifier of the group
group UpdateGroupDto
The group data transfer object
Returns
DeleteGroup(OctoObjectId)
Deletes a group.
Task DeleteGroup(OctoObjectId rtId)
Parameters
rtId OctoObjectId
The identifier of the group
Returns
UpdateGroupRoles(OctoObjectId, List<String>)
Updates the roles assigned to a group.
Task UpdateGroupRoles(OctoObjectId rtId, List<string> roleIds)
Parameters
rtId OctoObjectId
The identifier of the group
roleIds List<String>
The list of role IDs to assign
Returns
AddUserToGroup(OctoObjectId, String)
Adds a user to a group.
Task AddUserToGroup(OctoObjectId rtId, string userId)
Parameters
rtId OctoObjectId
The identifier of the group
userId String
The identifier of the user
Returns
RemoveUserFromGroup(OctoObjectId, String)
Removes a user from a group.
Task RemoveUserFromGroup(OctoObjectId rtId, string userId)
Parameters
rtId OctoObjectId
The identifier of the group
userId String
The identifier of the user
Returns
AddClientToGroup(OctoObjectId, String)
Adds a client to a group.
Task AddClientToGroup(OctoObjectId rtId, string clientId)
Parameters
rtId OctoObjectId
The identifier of the group
clientId String
The identifier of the client
Returns
RemoveClientFromGroup(OctoObjectId, String)
Removes a client from a group.
Task RemoveClientFromGroup(OctoObjectId rtId, string clientId)
Parameters
rtId OctoObjectId
The identifier of the group
clientId String
The identifier of the client
Returns
AddGroupToGroup(OctoObjectId, String)
Adds a child group to a parent group.
Task AddGroupToGroup(OctoObjectId rtId, string childGroupId)
Parameters
rtId OctoObjectId
The identifier of the parent group
childGroupId String
The identifier of the child group
Returns
RemoveGroupFromGroup(OctoObjectId, String)
Removes a child group from a parent group.
Task RemoveGroupFromGroup(OctoObjectId rtId, string childGroupId)
Parameters
rtId OctoObjectId
The identifier of the parent group
childGroupId String
The identifier of the child group
Returns
GetExternalTenantUserMappings(Nullable<Int32>, Nullable<Int32>, String)
Gets external tenant user mappings.
Task<IEnumerable<ExternalTenantUserMappingDto>> GetExternalTenantUserMappings(Nullable<int> skip, Nullable<int> take, string sourceTenantId)
Parameters
skip Nullable<Int32>
Number of items to skip
take Nullable<Int32>
Number of items to take
sourceTenantId String
Optional source tenant ID to filter by
Returns
Task<IEnumerable<ExternalTenantUserMappingDto>>
GetExternalTenantUserMapping(OctoObjectId)
Gets an external tenant user mapping by id.
Task<ExternalTenantUserMappingDto> GetExternalTenantUserMapping(OctoObjectId rtId)
Parameters
rtId OctoObjectId
The identifier of the mapping
Returns
Task<ExternalTenantUserMappingDto>
CreateExternalTenantUserMapping(CreateExternalTenantUserMappingDto)
Creates an external tenant user mapping.
Task CreateExternalTenantUserMapping(CreateExternalTenantUserMappingDto mapping)
Parameters
mapping CreateExternalTenantUserMappingDto
The mapping data transfer object
Returns
UpdateExternalTenantUserMapping(OctoObjectId, UpdateExternalTenantUserMappingDto)
Updates an external tenant user mapping.
Task UpdateExternalTenantUserMapping(OctoObjectId rtId, UpdateExternalTenantUserMappingDto mapping)
Parameters
rtId OctoObjectId
The identifier of the mapping
mapping UpdateExternalTenantUserMappingDto
The mapping data transfer object
Returns
DeleteExternalTenantUserMapping(OctoObjectId)
Deletes an external tenant user mapping.
Task DeleteExternalTenantUserMapping(OctoObjectId rtId)
Parameters
rtId OctoObjectId
The identifier of the mapping
Returns
GetAdminProvisioningMappings(String)
Gets admin provisioning mappings for a target tenant.
Task<IEnumerable<ExternalTenantUserMappingDto>> GetAdminProvisioningMappings(string targetTenantId)
Parameters
targetTenantId String
The target tenant ID
Returns
Task<IEnumerable<ExternalTenantUserMappingDto>>
CreateAdminProvisioningMapping(String, CreateExternalTenantUserMappingDto)
Creates an admin provisioning mapping in a target tenant.
Task CreateAdminProvisioningMapping(string targetTenantId, CreateExternalTenantUserMappingDto mapping)
Parameters
targetTenantId String
The target tenant ID
mapping CreateExternalTenantUserMappingDto
The mapping data transfer object
Returns
ProvisionCurrentUser(String)
Provisions the current user in a target tenant.
Task ProvisionCurrentUser(string targetTenantId)
Parameters
targetTenantId String
The target tenant ID
Returns
DeleteAdminProvisioningMapping(String, OctoObjectId)
Deletes an admin provisioning mapping from a target tenant.
Task DeleteAdminProvisioningMapping(string targetTenantId, OctoObjectId mappingRtId)
Parameters
targetTenantId String
The target tenant ID
mappingRtId OctoObjectId
The identifier of the mapping
Returns
ReconfigureLogLevelAsync(String, LogLevelDto, LogLevelDto)
Reconfigure the log level of the service.
Task ReconfigureLogLevelAsync(string loggerName, LogLevelDto minLogLevel, LogLevelDto maxLogLevel)
Parameters
loggerName String
Logger pattern name, e. g. Microsoft.*
minLogLevel LogLevelDto
Minimal log level to be logged.
maxLogLevel LogLevelDto
Maximum log level to be logged.
Returns
GetClientMirrors(String)
Lists the child tenants a ClientCredentials client has been auto-provisioned into.
Task<IEnumerable<ClientMirrorDto>> GetClientMirrors(string clientId)
Parameters
clientId String
Returns
Task<IEnumerable<ClientMirrorDto>>
ProvisionClientInExistingTenants(String)
Backfill: provisions this client into every existing child tenant of the
caller. Server returns 400 if the client isn't flagged with
=true.
Task<ClientMirrorBackfillResponseDto> ProvisionClientInExistingTenants(string clientId)
Parameters
clientId String
Returns
Task<ClientMirrorBackfillResponseDto>
ProvisionClientInTenant(String, String)
Provisions this client into a single named child tenant.
Task<ClientMirrorProvisionResponseDto> ProvisionClientInTenant(string clientId, string childTenantId)
Parameters
clientId String
childTenantId String
Returns
Task<ClientMirrorProvisionResponseDto>
UnprovisionClientFromTenant(String, String)
Removes a single mirror (drops both the child-side RtClient and
the parent's tracking row).
Task UnprovisionClientFromTenant(string clientId, string childTenantId)
Parameters
clientId String
childTenantId String
Returns
SetClientAutoProvisionInChildTenants(String, Boolean)
Flips the flag on a client without rewriting the full client object.
Task SetClientAutoProvisionInChildTenants(string clientId, bool enabled)
Parameters
clientId String
enabled Boolean
Returns
ApplyClientOverlay(String, ApplyOverlayUrisDto)
Applies an overlay URI set to a client (AB#4209 Step 4). The endpoint dedupes
each incoming URI against the existing list contents and appends new entries
with Source = "overlay:<OverlayName>". Idempotent — re-running with
the same payload is a no-op (no DB write, no cache invalidation). Returns
per-list (Added, SkippedDuplicate) counts.
Task<ApplyOverlayUrisResultDto> ApplyClientOverlay(string clientId, ApplyOverlayUrisDto dto)
Parameters
clientId String
dto ApplyOverlayUrisDto
Returns
Task<ApplyOverlayUrisResultDto>
CleanOverlayEntries(String)
Strips overlay URI entries from every blueprint-managed client in the tenant
(AB#4209 Step 5). Without overlayName: strips every entry
where Source starts with overlay:. With overlayName:
strips only entries where Source matches overlay:<overlayName>
exactly. Idempotent — clients with nothing to remove skip the per-client
UpdateAsync + cache invalidation. Returns per-client and total counts.
Task<CleanOverlayEntriesResultDto> CleanOverlayEntries(string overlayName)
Parameters
overlayName String
Returns
Task<CleanOverlayEntriesResultDto>
GetDataPermissions()
Returns all data permissions with their policies and role grants (AB#4972).
Task<IEnumerable<DataPermissionDto>> GetDataPermissions()
Returns
Task<IEnumerable<DataPermissionDto>>
CreateDataPermission(DataPermissionDto)
Creates a data permission.
Task CreateDataPermission(DataPermissionDto dataPermission)
Parameters
dataPermission DataPermissionDto
The permission to create
Returns
DeleteDataPermission(String)
Removes a data permission including its policies.
Task DeleteDataPermission(string permissionId)
Parameters
permissionId String
Dot-namespaced permission id
Returns
CreateDataPolicy(String, DataPolicyDto)
Creates a policy bound to a data permission. Returns the policy rtId.
Task<string> CreateDataPolicy(string permissionId, DataPolicyDto dataPolicy)
Parameters
permissionId String
Dot-namespaced permission id
dataPolicy DataPolicyDto
The policy to create
Returns
DeleteDataPolicy(String)
Removes a policy.
Task DeleteDataPolicy(string policyRtId)
Parameters
policyRtId String
RtId of the policy
Returns
SetDataPolicyEnforcementMode(String, String)
Switches a policy between Enforce and AuditOnly.
Task SetDataPolicyEnforcementMode(string policyRtId, string enforcementMode)
Parameters
policyRtId String
RtId of the policy
enforcementMode String
"Enforce" or "AuditOnly"
Returns
GrantDataPermissionToRole(String, String)
Grants a data permission to a role.
Task GrantDataPermissionToRole(string permissionId, string roleName)
Parameters
permissionId String
Dot-namespaced permission id
roleName String
Name of the role
Returns
RevokeDataPermissionFromRole(String, String)
Revokes a data permission from a role.
Task RevokeDataPermissionFromRole(string permissionId, string roleName)
Parameters
permissionId String
Dot-namespaced permission id
roleName String
Name of the role