Generate a complete group of commands for logging in and out of services based on provided auth definitions.

### Hierarchy

- CompleteAuthGroupBuilder

## Index

### Methods

- getAuthGroup

### Object literals

- defaultAuthGroup
- defaultLoginGroup
- defaultLogoutGroup

## Methods

### Static getAuthGroup

- getAuthGroup(authConfigs: {}, logger: Logger, authGroupConfig?: IImperativeAuthGroupConfig): ICommandDefinition

- - Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:37

  Get the complete auth group of commands

  #### Parameters

  - ##### authConfigs: {}

    mapping of profile types to auth configs

    - ##### [key: string]: ICommandProfileAuthConfig[]

  - ##### logger: Logger

    logger to use in the builder classes

  - ##### Default value authGroupConfig: IImperativeAuthGroupConfig = {}

    config that allows command definitions to be overridden

  #### Returns ICommandDefinition

  - the complete profile group of commands

## Object literals

### Static Private defaultAuthGroup

defaultAuthGroup: object

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:56

### children

children: undefined[] = []

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:61

### description

description: string = authCategoryDesc.message

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:59

### name

name: string = Constants.AUTH_GROUP

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:57

### summary

summary: string = authCategorySummary.message

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:58

### type

type: "group" = "group"

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:60

### Static Private defaultLoginGroup

defaultLoginGroup: object

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:64

### aliases

aliases: string[] = ["li"]

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:68

### children

children: undefined[] = []

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:70

### description

description: string = authLoginGroupDesc.message

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:66

### name

name: string = Constants.LOGIN_ACTION

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:65

### summary

summary: string = authLoginGroupSummary.message

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:67

### type

type: "group" = "group"

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:69

### Static Private defaultLogoutGroup

defaultLogoutGroup: object

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:73

### aliases

aliases: string[] = ["lo"]

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:77

### children

children: undefined[] = []

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:79

### description

description: string = authLogoutGroupDesc.message

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:75

### name

name: string = Constants.LOGOUT_ACTION

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:74

### summary

summary: string = authLogoutGroupSummary.message

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:76

### type

type: "group" = "group"

- Defined in @zowe/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts:78

Generated using TypeDoc