Documentation
    Preparing search index...

    Class GetIdentityOutput

    Index

    Constructors

    Properties

    Methods

    Constructors

    • 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: string
                    | null;
                };
                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: string | null;
                    };
                    employee_role: {
                        api_type: string;
                        description?: string;
                        value: string
                        | null;
                    };
                    expiration_date: {
                        api_type: string;
                        description?: string;
                        value: string
                        | null;
                    };
                    granted_by_byu_id: {
                        api_type: string;
                        description?: string;
                        value: string
                        | null;
                    };
                    granted_datetime: {
                        api_type: string;
                        description?: string;
                        value: string
                        | null;
                    };
                    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

    groupMemberships?: GetGroupMembershipsOutput
    validResponse: TypeCheck<
        TObject<
            {
                basic: TOptional<
                    TObject<
                        {
                            byu_id: TObject<
                                { api_type: TString; description: TOptional; value: TString },
                            >;
                            created_by_byu_id: TObject<
                                { api_type: TString; description: TOptional; value: TString },
                            >;
                            created_datetime: TObject<
                                { api_type: TString; description: TOptional; value: TString },
                            >;
                            datetime_ferpa_last_displayed: TObject<
                                { api_type: TString; description: TOptional; value: TUnion },
                            >;
                            identity_name: TObject<
                                { api_type: TString; description: TOptional; value: TString },
                            >;
                            identity_type: TObject<
                                { api_type: TString; description: TOptional; value: TString },
                            >;
                            merge_in_process: TObject<
                                { api_type: TString; description: TOptional; value: TBoolean },
                            >;
                            net_id: TObject<
                                { api_type: TString; description: TOptional; value: TString },
                            >;
                            person_id: TObject<
                                { api_type: TString; description: TOptional; value: TString },
                            >;
                            restricted: TObject<
                                { api_type: TString; description: TOptional; value: TBoolean },
                            >;
                            test_record_responsible_byu_id: TObject<
                                { api_type: TString; description: TOptional; value: TString },
                            >;
                            updated_by_byu_id: TObject<
                                { api_type: TString; description: TOptional; value: TString },
                            >;
                            updated_datetime: TObject<
                                { api_type: TString; description: TOptional; 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