athenz.Role

audit enabled flag for the role

AuditRef string

string containing audit specification or ticket number.

Member List<RoleMember>

If true, ask for delete confirmation in audit and review enabled roles

Description string

description for the role

LastReviewedDate string

The last reviewed timestamp for the role

A set of Athenz principal members

Members List<string>

Deprecated use member attribute instead (Optional) List of Athenz principal members. must be in this format: user.<userid> or <domain>.<service> or <domain>:group.<group>.

Deprecated: Deprecated

Name string

Name of the role

NotifyDetails string

Set of instructions included in notifications for review and audit enabled roles

NotifyRoles string

comma seperated list of roles whose members should be notified for member review/approval

comma seperated list of domains to enforce principal membership

Settings RoleSettings

Flag indicates whether role updates require another review and approval

RoleId string

The ID of this resource.

SelfRenew bool

Flag indicates whether to allow expired members to renew their membership

SelfRenewMins double

Number of minutes members can renew their membership if self review option is enabled

SelfServe bool

Flag indicates whether role allows self-service. Users can add themselves in the role, but it has to be approved by domain admins to be effective.

A map of advanced settings with the following options

SignAlgorithm string

sign algorithm to be used for tokens issued for this role: rsa or ec

Tags Dictionary<string, string>

Map of tags. The key is the tag-name and value is the tag-values are represented as a string with a comma separator. e.g. key1 = "val1,val2", this will be converted to: key1 = ["val1", "val2"]

Trust string

The domain, which this role is trusted to.

expiration enforced by a user authority configured attribute

membership filtered based on user authority configured attributes

Domain string

Name of the domain that role belongs to

audit enabled flag for the role

AuditRef string

string containing audit specification or ticket number.

Member []RoleMemberArgs

If true, ask for delete confirmation in audit and review enabled roles

Description string

description for the role

LastReviewedDate string

The last reviewed timestamp for the role

A set of Athenz principal members

Members []string

Deprecated use member attribute instead (Optional) List of Athenz principal members. must be in this format: user.<userid> or <domain>.<service> or <domain>:group.<group>.

Deprecated: Deprecated

Name string

Name of the role

NotifyDetails string

Set of instructions included in notifications for review and audit enabled roles

NotifyRoles string

comma seperated list of roles whose members should be notified for member review/approval

comma seperated list of domains to enforce principal membership

Settings RoleSettingsArgs

Flag indicates whether role updates require another review and approval

RoleId string

The ID of this resource.

SelfRenew bool

Flag indicates whether to allow expired members to renew their membership

SelfRenewMins float64

Number of minutes members can renew their membership if self review option is enabled

SelfServe bool

Flag indicates whether role allows self-service. Users can add themselves in the role, but it has to be approved by domain admins to be effective.

A map of advanced settings with the following options

SignAlgorithm string

sign algorithm to be used for tokens issued for this role: rsa or ec

Tags map[string]string

Map of tags. The key is the tag-name and value is the tag-values are represented as a string with a comma separator. e.g. key1 = "val1,val2", this will be converted to: key1 = ["val1", "val2"]

Trust string

The domain, which this role is trusted to.

expiration enforced by a user authority configured attribute

member List<RoleMember>

membership filtered based on user authority configured attributes

domain String

Name of the domain that role belongs to

auditEnabled Boolean

audit enabled flag for the role

auditRef String

string containing audit specification or ticket number.

deleteProtection Boolean

If true, ask for delete confirmation in audit and review enabled roles

description String

description for the role

lastReviewedDate String

The last reviewed timestamp for the role

A set of Athenz principal members

members List<String>

Deprecated use member attribute instead (Optional) List of Athenz principal members. must be in this format: user.<userid> or <domain>.<service> or <domain>:group.<group>.

Deprecated: Deprecated

name String

Name of the role

notifyDetails String

Set of instructions included in notifications for review and audit enabled roles

notifyRoles String

comma seperated list of roles whose members should be notified for member review/approval

comma seperated list of domains to enforce principal membership

reviewEnabled Boolean

Flag indicates whether role updates require another review and approval

roleId String

The ID of this resource.

selfRenew Boolean

Flag indicates whether to allow expired members to renew their membership

selfRenewMins Double

Number of minutes members can renew their membership if self review option is enabled

selfServe Boolean

Flag indicates whether role allows self-service. Users can add themselves in the role, but it has to be approved by domain admins to be effective.

A map of advanced settings with the following options

signAlgorithm String

sign algorithm to be used for tokens issued for this role: rsa or ec

tags Map<String,String>

Map of tags. The key is the tag-name and value is the tag-values are represented as a string with a comma separator. e.g. key1 = "val1,val2", this will be converted to: key1 = ["val1", "val2"]

trust String

The domain, which this role is trusted to.

expiration enforced by a user authority configured attribute

membership filtered based on user authority configured attributes

domain string

Name of the domain that role belongs to

auditEnabled boolean

audit enabled flag for the role

auditRef string

string containing audit specification or ticket number.

deleteProtection boolean

If true, ask for delete confirmation in audit and review enabled roles

description string

description for the role

lastReviewedDate string

The last reviewed timestamp for the role

member RoleMember[]

A set of Athenz principal members

members string[]

Deprecated use member attribute instead (Optional) List of Athenz principal members. must be in this format: user.<userid> or <domain>.<service> or <domain>:group.<group>.

Deprecated: Deprecated

name string

Name of the role

notifyDetails string

Set of instructions included in notifications for review and audit enabled roles

notifyRoles string

comma seperated list of roles whose members should be notified for member review/approval

principalDomainFilter string

comma seperated list of domains to enforce principal membership

reviewEnabled boolean

Flag indicates whether role updates require another review and approval

roleId string

The ID of this resource.

selfRenew boolean

Flag indicates whether to allow expired members to renew their membership

selfRenewMins number

Number of minutes members can renew their membership if self review option is enabled

selfServe boolean

Flag indicates whether role allows self-service. Users can add themselves in the role, but it has to be approved by domain admins to be effective.

member Sequence[RoleMemberArgs]

A map of advanced settings with the following options

signAlgorithm string

sign algorithm to be used for tokens issued for this role: rsa or ec

tags {[key: string]: string}

Map of tags. The key is the tag-name and value is the tag-values are represented as a string with a comma separator. e.g. key1 = "val1,val2", this will be converted to: key1 = ["val1", "val2"]

trust string

The domain, which this role is trusted to.

userAuthorityExpiration string

expiration enforced by a user authority configured attribute

userAuthorityFilter string

membership filtered based on user authority configured attributes

domain str

Name of the domain that role belongs to

audit_enabled bool

audit enabled flag for the role

audit_ref str

string containing audit specification or ticket number.

delete_protection bool

If true, ask for delete confirmation in audit and review enabled roles

description str

description for the role

last_reviewed_date str

The last reviewed timestamp for the role

A set of Athenz principal members

members Sequence[str]

Deprecated use member attribute instead (Optional) List of Athenz principal members. must be in this format: user.<userid> or <domain>.<service> or <domain>:group.<group>.

Deprecated: Deprecated

name str

Name of the role

notify_details str

Set of instructions included in notifications for review and audit enabled roles

notify_roles str

comma seperated list of roles whose members should be notified for member review/approval

principal_domain_filter str

comma seperated list of domains to enforce principal membership

review_enabled bool

Flag indicates whether role updates require another review and approval

role_id str

The ID of this resource.

self_renew bool

Flag indicates whether to allow expired members to renew their membership

self_renew_mins float

Number of minutes members can renew their membership if self review option is enabled

self_serve bool

Flag indicates whether role allows self-service. Users can add themselves in the role, but it has to be approved by domain admins to be effective.

settings RoleSettingsArgs

A map of advanced settings with the following options

sign_algorithm str

sign algorithm to be used for tokens issued for this role: rsa or ec

tags Mapping[str, str]

Map of tags. The key is the tag-name and value is the tag-values are represented as a string with a comma separator. e.g. key1 = "val1,val2", this will be converted to: key1 = ["val1", "val2"]

trust str

The domain, which this role is trusted to.

user_authority_expiration str

expiration enforced by a user authority configured attribute

user_authority_filter str

membership filtered based on user authority configured attributes

domain String

Name of the domain that role belongs to

auditEnabled Boolean

audit enabled flag for the role

auditRef String

string containing audit specification or ticket number.

deleteProtection Boolean

If true, ask for delete confirmation in audit and review enabled roles

description String

description for the role

lastReviewedDate String

The last reviewed timestamp for the role

member List<Property Map>

A set of Athenz principal members

members List<String>

Deprecated use member attribute instead (Optional) List of Athenz principal members. must be in this format: user.<userid> or <domain>.<service> or <domain>:group.<group>.

Deprecated: Deprecated

name String

Name of the role

notifyDetails String

Set of instructions included in notifications for review and audit enabled roles

notifyRoles String

comma seperated list of roles whose members should be notified for member review/approval

settings Property Map

comma seperated list of domains to enforce principal membership

reviewEnabled Boolean

Flag indicates whether role updates require another review and approval

roleId String

The ID of this resource.

selfRenew Boolean

Flag indicates whether to allow expired members to renew their membership

selfRenewMins Number

Number of minutes members can renew their membership if self review option is enabled

selfServe Boolean

Flag indicates whether role allows self-service. Users can add themselves in the role, but it has to be approved by domain admins to be effective.

A map of advanced settings with the following options

signAlgorithm String

sign algorithm to be used for tokens issued for this role: rsa or ec

tags Map<String>

Map of tags. The key is the tag-name and value is the tag-values are represented as a string with a comma separator. e.g. key1 = "val1,val2", this will be converted to: key1 = ["val1", "val2"]

trust String

The domain, which this role is trusted to.

expiration enforced by a user authority configured attribute

membership filtered based on user authority configured attributes

Outputs

All input properties are implicitly available as output properties. Additionally, the Role resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Role Resource

Get an existing Role resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: RoleState, opts?: CustomResourceOptions): Role

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        audit_enabled: Optional[bool] = None,
        audit_ref: Optional[str] = None,
        delete_protection: Optional[bool] = None,
        description: Optional[str] = None,
        domain: Optional[str] = None,
        last_reviewed_date: Optional[str] = None,
        member: Optional[Sequence[RoleMemberArgs]] = None,
        members: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        notify_details: Optional[str] = None,
        notify_roles: Optional[str] = None,
        principal_domain_filter: Optional[str] = None,
        review_enabled: Optional[bool] = None,
        role_id: Optional[str] = None,
        self_renew: Optional[bool] = None,
        self_renew_mins: Optional[float] = None,
        self_serve: Optional[bool] = None,
        settings: Optional[RoleSettingsArgs] = None,
        sign_algorithm: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        trust: Optional[str] = None,
        user_authority_expiration: Optional[str] = None,
        user_authority_filter: Optional[str] = None) -> Role

func GetRole(ctx *Context, name string, id IDInput, state *RoleState, opts ...ResourceOption) (*Role, error)

public static Role Get(string name, Input<string> id, RoleState? state, CustomResourceOptions? opts = null)

public static Role get(String name, Output<String> id, RoleState state, CustomResourceOptions options)

resources:  _:    type: athenz:Role    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

audit enabled flag for the role

AuditRef string

string containing audit specification or ticket number.

Member List<RoleMember>

If true, ask for delete confirmation in audit and review enabled roles

Description string

description for the role

Domain string

Name of the domain that role belongs to

LastReviewedDate string

The last reviewed timestamp for the role

A set of Athenz principal members

Members List<string>

Deprecated use member attribute instead (Optional) List of Athenz principal members. must be in this format: user.<userid> or <domain>.<service> or <domain>:group.<group>.

Deprecated: Deprecated

Name string

Name of the role

NotifyDetails string

Set of instructions included in notifications for review and audit enabled roles

NotifyRoles string

comma seperated list of roles whose members should be notified for member review/approval

comma seperated list of domains to enforce principal membership

Settings RoleSettings

Flag indicates whether role updates require another review and approval

RoleId string

The ID of this resource.

SelfRenew bool

Flag indicates whether to allow expired members to renew their membership

SelfRenewMins double

Number of minutes members can renew their membership if self review option is enabled

SelfServe bool

Flag indicates whether role allows self-service. Users can add themselves in the role, but it has to be approved by domain admins to be effective.

A map of advanced settings with the following options

SignAlgorithm string

sign algorithm to be used for tokens issued for this role: rsa or ec

Tags Dictionary<string, string>

Map of tags. The key is the tag-name and value is the tag-values are represented as a string with a comma separator. e.g. key1 = "val1,val2", this will be converted to: key1 = ["val1", "val2"]

Trust string

The domain, which this role is trusted to.

expiration enforced by a user authority configured attribute

membership filtered based on user authority configured attributes

audit enabled flag for the role

AuditRef string

string containing audit specification or ticket number.

Member []RoleMemberArgs

If true, ask for delete confirmation in audit and review enabled roles

Description string

description for the role

Domain string

Name of the domain that role belongs to

LastReviewedDate string

The last reviewed timestamp for the role

A set of Athenz principal members

Members []string

Deprecated use member attribute instead (Optional) List of Athenz principal members. must be in this format: user.<userid> or <domain>.<service> or <domain>:group.<group>.

Deprecated: Deprecated

Name string

Name of the role

NotifyDetails string

Set of instructions included in notifications for review and audit enabled roles

NotifyRoles string

comma seperated list of roles whose members should be notified for member review/approval

comma seperated list of domains to enforce principal membership

Settings RoleSettingsArgs

Flag indicates whether role updates require another review and approval

RoleId string

The ID of this resource.

SelfRenew bool

Flag indicates whether to allow expired members to renew their membership

SelfRenewMins float64

Number of minutes members can renew their membership if self review option is enabled

SelfServe bool

Flag indicates whether role allows self-service. Users can add themselves in the role, but it has to be approved by domain admins to be effective.

A map of advanced settings with the following options

SignAlgorithm string

sign algorithm to be used for tokens issued for this role: rsa or ec

Tags map[string]string

Map of tags. The key is the tag-name and value is the tag-values are represented as a string with a comma separator. e.g. key1 = "val1,val2", this will be converted to: key1 = ["val1", "val2"]

Trust string

The domain, which this role is trusted to.

expiration enforced by a user authority configured attribute

member List<RoleMember>

membership filtered based on user authority configured attributes

auditEnabled Boolean

audit enabled flag for the role

auditRef String

string containing audit specification or ticket number.

deleteProtection Boolean

If true, ask for delete confirmation in audit and review enabled roles

description String

description for the role

domain String

Name of the domain that role belongs to

lastReviewedDate String

The last reviewed timestamp for the role

A set of Athenz principal members

members List<String>

Deprecated use member attribute instead (Optional) List of Athenz principal members. must be in this format: user.<userid> or <domain>.<service> or <domain>:group.<group>.

Deprecated: Deprecated

name String

Name of the role

notifyDetails String

Set of instructions included in notifications for review and audit enabled roles

notifyRoles String

comma seperated list of roles whose members should be notified for member review/approval

comma seperated list of domains to enforce principal membership

reviewEnabled Boolean

Flag indicates whether role updates require another review and approval

roleId String

The ID of this resource.

selfRenew Boolean

Flag indicates whether to allow expired members to renew their membership

selfRenewMins Double

Number of minutes members can renew their membership if self review option is enabled

selfServe Boolean

Flag indicates whether role allows self-service. Users can add themselves in the role, but it has to be approved by domain admins to be effective.

A map of advanced settings with the following options

signAlgorithm String

sign algorithm to be used for tokens issued for this role: rsa or ec

tags Map<String,String>

Map of tags. The key is the tag-name and value is the tag-values are represented as a string with a comma separator. e.g. key1 = "val1,val2", this will be converted to: key1 = ["val1", "val2"]

trust String

The domain, which this role is trusted to.

expiration enforced by a user authority configured attribute

membership filtered based on user authority configured attributes

auditEnabled boolean

audit enabled flag for the role

auditRef string

string containing audit specification or ticket number.

deleteProtection boolean

If true, ask for delete confirmation in audit and review enabled roles

description string

description for the role

domain string

Name of the domain that role belongs to

lastReviewedDate string

The last reviewed timestamp for the role

member RoleMember[]

A set of Athenz principal members

members string[]

Deprecated use member attribute instead (Optional) List of Athenz principal members. must be in this format: user.<userid> or <domain>.<service> or <domain>:group.<group>.

Deprecated: Deprecated

name string

Name of the role

notifyDetails string

Set of instructions included in notifications for review and audit enabled roles

notifyRoles string

comma seperated list of roles whose members should be notified for member review/approval

principalDomainFilter string

comma seperated list of domains to enforce principal membership

reviewEnabled boolean

Flag indicates whether role updates require another review and approval

roleId string

The ID of this resource.

selfRenew boolean

Flag indicates whether to allow expired members to renew their membership

selfRenewMins number

Number of minutes members can renew their membership if self review option is enabled

selfServe boolean

Flag indicates whether role allows self-service. Users can add themselves in the role, but it has to be approved by domain admins to be effective.

member Sequence[RoleMemberArgs]

A map of advanced settings with the following options

signAlgorithm string

sign algorithm to be used for tokens issued for this role: rsa or ec

tags {[key: string]: string}

Map of tags. The key is the tag-name and value is the tag-values are represented as a string with a comma separator. e.g. key1 = "val1,val2", this will be converted to: key1 = ["val1", "val2"]

trust string

The domain, which this role is trusted to.

userAuthorityExpiration string

expiration enforced by a user authority configured attribute

userAuthorityFilter string

membership filtered based on user authority configured attributes

audit_enabled bool

audit enabled flag for the role

audit_ref str

string containing audit specification or ticket number.

delete_protection bool

If true, ask for delete confirmation in audit and review enabled roles

description str

description for the role

domain str

Name of the domain that role belongs to

last_reviewed_date str

The last reviewed timestamp for the role

A set of Athenz principal members

members Sequence[str]

Deprecated use member attribute instead (Optional) List of Athenz principal members. must be in this format: user.<userid> or <domain>.<service> or <domain>:group.<group>.

Deprecated: Deprecated

name str

Name of the role

notify_details str

Set of instructions included in notifications for review and audit enabled roles

notify_roles str

comma seperated list of roles whose members should be notified for member review/approval

principal_domain_filter str

comma seperated list of domains to enforce principal membership

review_enabled bool

Flag indicates whether role updates require another review and approval

role_id str

The ID of this resource.

self_renew bool

Flag indicates whether to allow expired members to renew their membership

self_renew_mins float

Number of minutes members can renew their membership if self review option is enabled

self_serve bool

Flag indicates whether role allows self-service. Users can add themselves in the role, but it has to be approved by domain admins to be effective.

settings RoleSettingsArgs

A map of advanced settings with the following options

sign_algorithm str

sign algorithm to be used for tokens issued for this role: rsa or ec

tags Mapping[str, str]

Map of tags. The key is the tag-name and value is the tag-values are represented as a string with a comma separator. e.g. key1 = "val1,val2", this will be converted to: key1 = ["val1", "val2"]

trust str

The domain, which this role is trusted to.

user_authority_expiration str

expiration enforced by a user authority configured attribute

user_authority_filter str

membership filtered based on user authority configured attributes

auditEnabled Boolean

audit enabled flag for the role

auditRef String

string containing audit specification or ticket number.

deleteProtection Boolean

If true, ask for delete confirmation in audit and review enabled roles

description String

description for the role

domain String

Name of the domain that role belongs to

lastReviewedDate String

The last reviewed timestamp for the role

member List<Property Map>

A set of Athenz principal members

members List<String>

Deprecated use member attribute instead (Optional) List of Athenz principal members. must be in this format: user.<userid> or <domain>.<service> or <domain>:group.<group>.

Deprecated: Deprecated

name String

Name of the role

notifyDetails String

Set of instructions included in notifications for review and audit enabled roles

notifyRoles String

comma seperated list of roles whose members should be notified for member review/approval

settings Property Map

comma seperated list of domains to enforce principal membership

reviewEnabled Boolean

Flag indicates whether role updates require another review and approval

roleId String

The ID of this resource.

selfRenew Boolean

Flag indicates whether to allow expired members to renew their membership

selfRenewMins Number

Number of minutes members can renew their membership if self review option is enabled

selfServe Boolean

Flag indicates whether role allows self-service. Users can add themselves in the role, but it has to be approved by domain admins to be effective.

A map of advanced settings with the following options

signAlgorithm String

sign algorithm to be used for tokens issued for this role: rsa or ec

tags Map<String>

Map of tags. The key is the tag-name and value is the tag-values are represented as a string with a comma separator. e.g. key1 = "val1,val2", this will be converted to: key1 = ["val1", "val2"]

trust String

The domain, which this role is trusted to.

expiration enforced by a user authority configured attribute