Skip to main content

Pyrae::IAM::SelfManagedUser Reference

Quick Type Reference​

export interface PyraeIAMSelfManagedUser {
    Name?: string;
    
    Emails?: string[];
    FirstName?: string;
    LastName?: string;
    JobTitle?: string;
    Username?: string;
    ManagerUsername?: string;
    
    DirectoryGroups: {
        GroupId: string;
        GroupName: string;
    }[];
}

PyraeIAMSelfManagedUser​

This object creates a user with Pyrae-managed credentials. All fields are optional and can be used by Pyrae::IAM::TeamMembershipRule to identify user group memberships.

Name​

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

Required: No

Location: $.PyraeIAMSelfManagedUser.Name

Type: export type Name = string;

Emails​

Description: The email associated with this user.

Required: No

Location: $.PyraeIAMSelfManagedUser.Emails

Type: 

/** The email associated with this user. */
export type Emails = string[];

FirstName​

Description: The First Name associated with this user.

Required: No

Location: $.PyraeIAMSelfManagedUser.FirstName

Type: export type FirstName = string;

LastName​

Description: The Last Name associated with this user.

Required: No

Location: $.PyraeIAMSelfManagedUser.LastName

Type: export type LastName = string;

JobTitle​

Description: The Job Title associated with this user.

Required: No

Location: $.PyraeIAMSelfManagedUser.JobTitle

Type: export type JobTitle = string;

Username​

Description: The Username associated with this user.

Required: No

Location: $.PyraeIAMSelfManagedUser.Username

Type: export type Username = string;

ManagerUsername​

Description: The Username associated with this user's manager.

Required: No

Location: $.PyraeIAMSelfManagedUser.ManagerUsername

Type: export type ManagerUsername = string;

DirectoryGroups​

Description: The groups associated with this user (eg, devops).

Required: Yes

Location: $.PyraeIAMSelfManagedUser.DirectoryGroups

Type: 

/** The groups associated with this user (eg, devops). */
export type DirectoryGroups = {
    GroupId: string;
    GroupName: string;
}[];

JSON Schema​

{
  "$ref": "#/definitions/PyraeIAMSelfManagedUser",
  "definitions": {
    "PyraeIAMSelfManagedUser": {
      "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"
        },
        "Emails": {
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "string"
              }
            ]
          },
          "description": "The email associated with this user."
        },
        "FirstName": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The First Name associated with this user."
        },
        "LastName": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The Last Name associated with this user."
        },
        "JobTitle": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The Job Title associated with this user."
        },
        "Username": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The Username associated with this user."
        },
        "ManagerUsername": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The Username associated with this user's manager."
        },
        "DirectoryGroups": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "GroupId": {
                "anyOf": [
                  {
                    "type": "string"
                  }
                ]
              },
              "GroupName": {
                "anyOf": [
                  {
                    "type": "string"
                  }
                ]
              }
            },
            "required": [
              "GroupId",
              "GroupName"
            ],
            "additionalProperties": false
          },
          "description": "The groups associated with this user (eg, devops)."
        }
      },
      "required": [
        "DirectoryGroups"
      ],
      "additionalProperties": false,
      "description": "This object creates a user with Pyrae-managed credentials. All fields are optional and can be used by Pyrae::IAM::TeamMembershipRule to identify user group memberships."
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}