Class GetIdentityOutput

Constructors

constructor

Properties

basic? groupMemberships? validResponse

Methods

from

Constructors

constructor

  • new GetIdentityOutput(data): GetIdentityOutput

  • Parameters

    • data: {
          basic?: {
              byu_id: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              created_by_byu_id: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              created_datetime: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              datetime_ferpa_last_displayed: {
                  api_type: string;
                  description?: string;
                  value: null | string;
              };
              identity_name: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              identity_type: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              merge_in_process: {
                  api_type: string;
                  description?: string;
                  value: boolean;
              };
              net_id: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              person_id: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              restricted: {
                  api_type: string;
                  description?: string;
                  value: boolean;
              };
              test_record_responsible_byu_id: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              updated_by_byu_id: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              updated_datetime: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
          };
          group_memberships?: {
              values: {
                  byu_id: {
                      api_type: string;
                      description?: string;
                      value: string;
                  };
                  effective_date: {
                      api_type: string;
                      description?: string;
                      value: null | string;
                  };
                  employee_role: {
                      api_type: string;
                      description?: string;
                      value: null | string;
                  };
                  expiration_date: {
                      api_type: string;
                      description?: string;
                      value: null | string;
                  };
                  granted_by_byu_id: {
                      api_type: string;
                      description?: string;
                      value: null | string;
                  };
                  granted_datetime: {
                      api_type: string;
                      description?: string;
                      value: null | string;
                  };
                  group_id: {
                      api_type: string;
                      description?: string;
                      value: string;
                  };
                  group_type: {
                      api_type: string;
                      description?: string;
                      value: string;
                  };
                  implied_by: {
                      value_array: {
                          api_type: string;
                          description?: string;
                          value: string;
                      }[];
                  };
                  job_code: {
                      api_type: string;
                      description?: string;
                      value: string;
                  };
                  membership_type: {
                      api_type: string;
                      description?: string;
                      value: string;
                  };
              }[];
          };
      }
      • Optional basic?: {
            byu_id: {
                api_type: string;
                description?: string;
                value: string;
            };
            created_by_byu_id: {
                api_type: string;
                description?: string;
                value: string;
            };
            created_datetime: {
                api_type: string;
                description?: string;
                value: string;
            };
            datetime_ferpa_last_displayed: {
                api_type: string;
                description?: string;
                value: null | string;
            };
            identity_name: {
                api_type: string;
                description?: string;
                value: string;
            };
            identity_type: {
                api_type: string;
                description?: string;
                value: string;
            };
            merge_in_process: {
                api_type: string;
                description?: string;
                value: boolean;
            };
            net_id: {
                api_type: string;
                description?: string;
                value: string;
            };
            person_id: {
                api_type: string;
                description?: string;
                value: string;
            };
            restricted: {
                api_type: string;
                description?: string;
                value: boolean;
            };
            test_record_responsible_byu_id: {
                api_type: string;
                description?: string;
                value: string;
            };
            updated_by_byu_id: {
                api_type: string;
                description?: string;
                value: string;
            };
            updated_datetime: {
                api_type: string;
                description?: string;
                value: string;
            };
        }
        • byu_id: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • created_by_byu_id: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • created_datetime: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • datetime_ferpa_last_displayed: {
              api_type: string;
              description?: string;
              value: null | string;
          }
          • api_type: string
          • Optional description?: string
          • value: null | string
        • identity_name: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • identity_type: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • merge_in_process: {
              api_type: string;
              description?: string;
              value: boolean;
          }
          • api_type: string
          • Optional description?: string
          • value: boolean
        • net_id: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • person_id: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • restricted: {
              api_type: string;
              description?: string;
              value: boolean;
          }
          • api_type: string
          • Optional description?: string
          • value: boolean
        • test_record_responsible_byu_id: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • updated_by_byu_id: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
        • updated_datetime: {
              api_type: string;
              description?: string;
              value: string;
          }
          • api_type: string
          • Optional description?: string
          • value: string
      • Optional group_memberships?: {
            values: {
                byu_id: {
                    api_type: string;
                    description?: string;
                    value: string;
                };
                effective_date: {
                    api_type: string;
                    description?: string;
                    value: null | string;
                };
                employee_role: {
                    api_type: string;
                    description?: string;
                    value: null | string;
                };
                expiration_date: {
                    api_type: string;
                    description?: string;
                    value: null | string;
                };
                granted_by_byu_id: {
                    api_type: string;
                    description?: string;
                    value: null | string;
                };
                granted_datetime: {
                    api_type: string;
                    description?: string;
                    value: null | string;
                };
                group_id: {
                    api_type: string;
                    description?: string;
                    value: string;
                };
                group_type: {
                    api_type: string;
                    description?: string;
                    value: string;
                };
                implied_by: {
                    value_array: {
                        api_type: string;
                        description?: string;
                        value: string;
                    }[];
                };
                job_code: {
                    api_type: string;
                    description?: string;
                    value: string;
                };
                membership_type: {
                    api_type: string;
                    description?: string;
                    value: string;
                };
            }[];
        }
        • values: {
              byu_id: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              effective_date: {
                  api_type: string;
                  description?: string;
                  value: null | string;
              };
              employee_role: {
                  api_type: string;
                  description?: string;
                  value: null | string;
              };
              expiration_date: {
                  api_type: string;
                  description?: string;
                  value: null | string;
              };
              granted_by_byu_id: {
                  api_type: string;
                  description?: string;
                  value: null | string;
              };
              granted_datetime: {
                  api_type: string;
                  description?: string;
                  value: null | string;
              };
              group_id: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              group_type: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              implied_by: {
                  value_array: {
                      api_type: string;
                      description?: string;
                      value: string;
                  }[];
              };
              job_code: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
              membership_type: {
                  api_type: string;
                  description?: string;
                  value: string;
              };
          }[]

    Returns GetIdentityOutput

Properties

Optional basic

basic?: GetIdentityBasicOutput

Optional groupMemberships

groupMemberships?: GetGroupMembershipsOutput

Static validResponse

validResponse: TypeCheck<TObject<{
    basic: TOptional<TObject<{
        byu_id: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        created_by_byu_id: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        created_datetime: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        datetime_ferpa_last_displayed: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TUnion<[TString, TNull]>;
        }>;
        identity_name: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        identity_type: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        merge_in_process: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TBoolean;
        }>;
        net_id: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        person_id: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        restricted: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TBoolean;
        }>;
        test_record_responsible_byu_id: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        updated_by_byu_id: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
        updated_datetime: TObject<{
            api_type: TString;
            description: TOptional<TString>;
            value: TString;
        }>;
    }>>;
    group_memberships: TOptional<TObject<{
        values: TArray<TObject<{
            byu_id: TObject<{
                api_type: ...;
                description: ...;
                value: ...;
            }>;
            effective_date: TObject<{
                api_type: ...;
                description: ...;
                value: ...;
            }>;
            employee_role: TObject<{
                api_type: ...;
                description: ...;
                value: ...;
            }>;
            expiration_date: TObject<{
                api_type: ...;
                description: ...;
                value: ...;
            }>;
            granted_by_byu_id: TObject<{
                api_type: ...;
                description: ...;
                value: ...;
            }>;
            granted_datetime: TObject<{
                api_type: ...;
                description: ...;
                value: ...;
            }>;
            group_id: TObject<{
                api_type: ...;
                description: ...;
                value: ...;
            }>;
            group_type: TObject<{
                api_type: ...;
                description: ...;
                value: ...;
            }>;
            implied_by: TObject<{
                value_array: ...;
            }>;
            job_code: TObject<{
                api_type: ...;
                description: ...;
                value: ...;
            }>;
            membership_type: TObject<{
                api_type: ...;
                description: ...;
                value: ...;
            }>;
        }>>;
    }>>;
}>> = ...

Methods

Static from

Settings

Member Visibility

Theme

On This Page

constructorbasicgroupMembershipsvalidResponsefrom