Type Alias StaticUserMapping

type StaticUserMapping = {
    createStaticUserMapping(
        mapping: StaticUserMappingSkeleton,
    ): Promise<StaticUserMappingSkeleton>;
    deleteStaticUserMapping(
        subject: string,
    ): Promise<StaticUserMappingSkeleton>;
    ensureStaticUserMapping(
        mapping: StaticUserMappingSkeleton,
    ): Promise<StaticUserMappingResult>;
    readStaticUserMapping(subject: string): Promise<StaticUserMappingSkeleton>;
    readStaticUserMappings(): Promise<StaticUserMappingSkeleton[]>;
    updateStaticUserMapping(
        mapping: StaticUserMappingSkeleton,
    ): Promise<StaticUserMappingSkeleton>;
}

Index

Methods

createStaticUserMapping deleteStaticUserMapping ensureStaticUserMapping readStaticUserMapping readStaticUserMappings updateStaticUserMapping

Methods

createStaticUserMapping

createStaticUserMapping(
mapping: StaticUserMappingSkeleton,
): Promise<StaticUserMappingSkeleton>
Create the static user mapping of a subject. Fails if the subject has one already.
Parameters
- mapping: StaticUserMappingSkeleton
  the static user mapping
Returns Promise<StaticUserMappingSkeleton>
a promise that resolves to the created static user mapping
- Defined in ops/StaticUserMappingOps.ts:24

deleteStaticUserMapping

deleteStaticUserMapping(subject: string): Promise<StaticUserMappingSkeleton>
Delete the static user mapping of a subject. Fails if there is none. Other mappings are not touched.
Parameters
- subject: string
  the subject
Returns Promise<StaticUserMappingSkeleton>
a promise that resolves to the deleted static user mapping
- Defined in ops/StaticUserMappingOps.ts:56

ensureStaticUserMapping

ensureStaticUserMapping(
mapping: StaticUserMappingSkeleton,
): Promise<StaticUserMappingResult>
Make sure a subject has a static user mapping with at least the given roles, and change nothing that is there already: a missing mapping is created, the roles of an existing one are merged (never removed), other properties of an existing mapping are kept, and nothing is written when there is nothing to add. An existing mapping that names another local user (or another userRoles) is not changed: that would point the subject at a different identity, so the call fails, and updateStaticUserMapping is the explicit way.
Parameters
- mapping: StaticUserMappingSkeleton
  the static user mapping to ensure
Returns Promise<StaticUserMappingResult>
a promise that resolves to the resulting mapping and what was done
- Defined in ops/StaticUserMappingOps.ts:47

readStaticUserMapping

readStaticUserMapping(subject: string): Promise<StaticUserMappingSkeleton>
Read the static user mapping of a subject. Fails if there is none.
Parameters
- subject: string
  the subject (the sub of the access token, e.g. an OAuth2 client id)
Returns Promise<StaticUserMappingSkeleton>
a promise that resolves to a static user mapping
- Defined in ops/StaticUserMappingOps.ts:18

readStaticUserMappings

readStaticUserMappings(): Promise<StaticUserMappingSkeleton[]>
Read all static user mappings of the IDM authentication configuration

Returns Promise<StaticUserMappingSkeleton[]>
a promise that resolves to an array of static user mappings (empty if there are none)
- Defined in ops/StaticUserMappingOps.ts:12

updateStaticUserMapping

updateStaticUserMapping(
mapping: StaticUserMappingSkeleton,
): Promise<StaticUserMappingSkeleton>
Update or create the static user mapping of a subject. An existing mapping of the subject is replaced as given.
Parameters
- mapping: StaticUserMappingSkeleton
  the static user mapping
Returns Promise<StaticUserMappingSkeleton>
a promise that resolves to the written static user mapping
- Defined in ops/StaticUserMappingOps.ts:33