Skip to main content

Pyrae::IAM::TeamMembershipRule Reference

Quick Type Reference​

export interface PyraeIAMTeamMembershipRule {
    Name?: string;
    TargetTeamUrn?: string;
    Email?: string;
    FirstName?: string;
    LastName?: string;
    JobTitle?: string;
    Username?: string;
    ManagerUsername?: string;
    GroupId?: string;
    GroupName?: string;
}

PyraeIAMTeamMembershipRule​

The Pyrae::IAM::TeamMembershipRule assigns users to a specified Team. All fields in this rule are evaluated with a logical AND. Note, omitted fields match all.

Name​

Description: The resourceName of the URN. By default, one will be generated based on the logical ID with randomness appended to the end

Location: $.PyraeIAMTeamMembershipRule.Name

Type: export type Name = string;

TargetTeamUrn​

Description: The URN of the team that users matching subsequent fields will join.

Location: $.PyraeIAMTeamMembershipRule.TargetTeamUrn

Type: export type TargetTeamUrn = string;

Email​

Description: The email that the user must have in order to match this rule. Case sensitive.

Location: $.PyraeIAMTeamMembershipRule.Email

Type: export type Email = string;

FirstName​

Description: The first name that the user must have in order to match this rule. Case sensitive.

Location: $.PyraeIAMTeamMembershipRule.FirstName

Type: export type FirstName = string;

LastName​

Description: The last name that the user must have in order to match this rule. Case sensitive.

Location: $.PyraeIAMTeamMembershipRule.LastName

Type: export type LastName = string;

JobTitle​

Description: The job title that the user must have in order to match this rule. Case sensitive.

Location: $.PyraeIAMTeamMembershipRule.JobTitle

Type: export type JobTitle = string;

Username​

Description: The username that the user must have in order to match this rule. Case sensitive.

Location: $.PyraeIAMTeamMembershipRule.Username

Type: export type Username = string;

ManagerUsername​

Description: The manager's username that the user must have in order to match this rule. Case sensitive.

Location: $.PyraeIAMTeamMembershipRule.ManagerUsername

Type: export type ManagerUsername = string;

GroupId​

Description: The user must be a member of this groupId in order to match this rule. Since users can be in multiple groups, if GroupName is also specified, both fields must match on the same rule. Case sensitive.

Location: $.PyraeIAMTeamMembershipRule.GroupId

Type: export type GroupId = string;

GroupName​

Description: The user must be a member of this groupName in order to match this rule. Since users can be in multiple groups, if GroupId is also specified, both fields must match on the same rule. Case sensitive.

Location: $.PyraeIAMTeamMembershipRule.GroupName

Type: export type GroupName = string;

JSON Schema​

{
  "$ref": "#/definitions/PyraeIAMTeamMembershipRule",
  "definitions": {
    "PyraeIAMTeamMembershipRule": {
      "type": "object",
      "properties": {
        "Name": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The resourceName of the URN. By default, one will be generated based on the logical ID with randomness appended to the end"
        },
        "TargetTeamUrn": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The URN of the team that users matching subsequent fields will join."
        },
        "Email": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The email that the user must have in order to match this rule. Case sensitive."
        },
        "FirstName": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The first name that the user must have in order to match this rule. Case sensitive."
        },
        "LastName": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The last name that the user must have in order to match this rule. Case sensitive."
        },
        "JobTitle": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The job title that the user must have in order to match this rule. Case sensitive."
        },
        "Username": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The username that the user must have in order to match this rule. Case sensitive."
        },
        "ManagerUsername": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The manager's username that the user must have in order to match this rule. Case sensitive."
        },
        "GroupId": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The user must be a member of this groupId in order to match this rule. Since users can be in multiple groups, if GroupName is also specified, both fields must match on the same rule. Case sensitive."
        },
        "GroupName": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The user must be a member of this groupName in order to match this rule. Since users can be in multiple groups, if GroupId is also specified, both fields must match on the same rule. Case sensitive."
        }
      },
      "additionalProperties": false,
      "description": "The Pyrae::IAM::TeamMembershipRule assigns users to a specified Team. All fields in this rule are evaluated with a logical AND. Note, omitted fields match all."
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}