Class OpenBiAuthObjectExtensions

Extension methods for auth objects.

Inheritance
object
OpenBiAuthObjectExtensions
Syntax
public static class OpenBiAuthObjectExtensions

Methods

CreateAuthObjectAsync(IOpenBiSession, IAuthObject, CancellationToken)

Creates or updates an auth object.

Declaration
public static Task CreateAuthObjectAsync(this IOpenBiSession session, IAuthObject authObject, CancellationToken cancellationToken = default)
Returns
Type Description
Task

CreateAuthObjectValueAsync(IOpenBiSession, IAuthObjectValue, CancellationToken)

Creates or updates an auth object value.

Declaration
public static Task CreateAuthObjectValueAsync(this IOpenBiSession session, IAuthObjectValue authObjectValue, CancellationToken cancellationToken = default)
Returns
Type Description
Task

DeleteAuthObjectAsync(IOpenBiSession, IAuthObject, CancellationToken)

Deletes an auth object.

Declaration
public static Task DeleteAuthObjectAsync(this IOpenBiSession session, IAuthObject authObject, CancellationToken cancellationToken = default)
Returns
Type Description
Task

DeleteAuthObjectAsync(IOpenBiSession, string, CancellationToken)

Deletes an auth object by id.

Declaration
public static Task DeleteAuthObjectAsync(this IOpenBiSession session, string id, CancellationToken cancellationToken = default)
Returns
Type Description
Task

DeleteAuthObjectsAsync(IOpenBiSession, IEnumerable<IAuthObject>, CancellationToken)

Deletes auth objects.

Declaration
public static Task DeleteAuthObjectsAsync(this IOpenBiSession session, IEnumerable<IAuthObject> authObjects, CancellationToken cancellationToken = default)
Returns
Type Description
Task

DeleteAuthObjectsAsync(IOpenBiSession, IEnumerable<string>, CancellationToken)

Deletes auth objects by id.

Declaration
public static Task DeleteAuthObjectsAsync(this IOpenBiSession session, IEnumerable<string> ids, CancellationToken cancellationToken = default)
Returns
Type Description
Task

DeleteAuthObjectValueAsync(IOpenBiSession, IAuthObjectValue, CancellationToken)

Deletes an auth object value.

Declaration
public static Task DeleteAuthObjectValueAsync(this IOpenBiSession session, IAuthObjectValue authObjectValue, CancellationToken cancellationToken = default)
Returns
Type Description
Task

DeleteAuthObjectValueAsync(IOpenBiSession, string, CancellationToken)

Deletes an auth object value by id.

Declaration
public static Task DeleteAuthObjectValueAsync(this IOpenBiSession session, string id, CancellationToken cancellationToken = default)
Returns
Type Description
Task

DeleteAuthObjectValuesAsync(IOpenBiSession, IEnumerable<IAuthObjectValue>, CancellationToken)

Deletes auth object values.

Declaration
public static Task DeleteAuthObjectValuesAsync(this IOpenBiSession session, IEnumerable<IAuthObjectValue> authObjectValues, CancellationToken cancellationToken = default)
Returns
Type Description
Task

DeleteAuthObjectValuesAsync(IOpenBiSession, IEnumerable<string>, CancellationToken)

Deletes auth object values by id.

Declaration
public static Task DeleteAuthObjectValuesAsync(this IOpenBiSession session, IEnumerable<string> ids, CancellationToken cancellationToken = default)
Returns
Type Description
Task

GetAuthObjectsAsync(IOpenBiSession, CancellationToken)

Returns all auth objects.

Declaration
public static Task<IList<IAuthObject>> GetAuthObjectsAsync(this IOpenBiSession session, CancellationToken cancellationToken = default)

GetAuthObjectValueByIdAsync(IOpenBiSession, string, CancellationToken)

Returns an auth object by its id.

Declaration
public static Task<IAuthObjectValue?> GetAuthObjectValueByIdAsync(this IOpenBiSession session, string id, CancellationToken cancellationToken = default)

GetAuthObjectValuesAsync(IOpenBiSession, CancellationToken)

Returns all auth object values.

Declaration
public static Task<IList<IAuthObjectValue>> GetAuthObjectValuesAsync(this IOpenBiSession session, CancellationToken cancellationToken = default)

GetAuthObjectValuesByOwnerAsync(IOpenBiSession, string, string, CancellationToken)

Returns all auth objects for an owner and auth object id.

Declaration
public static Task<IList<IAuthObjectValue>> GetAuthObjectValuesByOwnerAsync(this IOpenBiSession session, string owner, string authObjectId, CancellationToken cancellationToken = default)
Remarks

The owner is typically a username or organisation id.

GetAuthObjectValuesByOwnerAsync(IOpenBiSession, string, CancellationToken)

Returns all auth objects for an owner.

Declaration
public static Task<IList<IAuthObjectValue>> GetAuthObjectValuesByOwnerAsync(this IOpenBiSession session, string owner, CancellationToken cancellationToken = default)
Remarks

The owner is typically a username or organisation id.