Documentation
Types
Team
TeamLimited

TeamLimited

A limited form of data representing a Team, due to the authentication token missing privileges to read the full Team data.

export interface TeamLimited {
    /**
     * Property indicating that this Team data contains only limited information,
     * due to the authentication token missing privileges to read the full Team data.
     * Re-login with the Team's configured SAML Single Sign-On provider in order
     * to upgrade the authentication token with the necessary privileges.
     */
    limited: boolean;
 
    /**
     * When "Single Sign-On (SAML)" is configured, this object contains information
     * that allows the client-side to identify whether or not this Team has SAML enforced.
     */
    saml?: {
        /**
         * Information for the SAML Single Sign-On configuration.
         */
        connection?: {
            /**
             * The Identity Provider "type", for example Okta.
             */
            type: string;
 
            /**
             * Current status of the connection.
             */
            status: string;
 
            /**
             * Current state of the connection.
             */
            state: string;
 
            /**
             * Timestamp (in milliseconds) of when the configuration was connected.
             */
            connectedAt: number;
 
            /**
             * Timestamp (in milliseconds) of when the last webhook event was received from WorkOS.
             */
            lastReceivedWebhookEvent?: number;
        };
 
        /**
         * Information for the SAML Single Sign-On configuration.
         */
        directory?: {
            /**
             * The Identity Provider "type", for example Okta.
             */
            type: string;
 
            /**
             * Current status of the connection.
             */
            status: string;
 
            /**
             * Current state of the connection.
             */
            state: string;
 
            /**
             * Timestamp (in milliseconds) of when the configuration was connected.
             */
            connectedAt: number;
 
            /**
             * Timestamp (in milliseconds) of when the last webhook event was received from WorkOS.
             */
            lastReceivedWebhookEvent?: number;
        };
 
        /**
         * When `true`, interactions with the Team **must** be done with an authentication
         * token that has been authenticated with the Team's SAML Single Sign-On provider.
         */
        enforced: boolean;
    };
 
    /**
     * The Team's unique identifier.
     */
    id: string;
 
    /**
     * The Team's slug, which is unique across the Vercel platform.
     */
    slug: string;
 
    /**
     * Name associated with the Team account, or `null` if none has been provided.
     */
    name: string | null;
 
    /**
     * The ID of the file used as avatar for this Team.
     */
    avatar: string | null;
    membership:
        | {
              confirmed: boolean;
              confirmedAt: number;
              accessRequestedAt?: number;
              role:
                  | 'OWNER'
                  | 'MEMBER'
                  | 'DEVELOPER'
                  | 'BILLING'
                  | 'VIEWER'
                  | 'CONTRIBUTOR';
              teamId?: string;
              uid: string;
              createdAt: number;
              created: number;
              joinedFrom?: {
                  origin:
                      | 'link'
                      | 'saml'
                      | 'mail'
                      | 'import'
                      | 'teams'
                      | 'github'
                      | 'gitlab'
                      | 'bitbucket'
                      | 'dsync'
                      | 'feedback'
                      | 'organization-teams';
                  commitId?: string;
                  repoId?: string;
                  repoPath?: string;
                  gitUserId?: string | number;
                  gitUserLogin?: string;
                  ssoUserId?: string;
                  ssoConnectedAt?: number;
                  idpUserId?: string;
                  dsyncUserId?: string;
                  dsyncConnectedAt?: number;
              };
          }
        | {
              confirmed: boolean;
              confirmedAt?: number;
              accessRequestedAt: number;
              role:
                  | 'OWNER'
                  | 'MEMBER'
                  | 'DEVELOPER'
                  | 'BILLING'
                  | 'VIEWER'
                  | 'CONTRIBUTOR';
              teamId?: string;
              uid: string;
              createdAt: number;
              created: number;
              joinedFrom?: {
                  origin:
                      | 'link'
                      | 'saml'
                      | 'mail'
                      | 'import'
                      | 'teams'
                      | 'github'
                      | 'gitlab'
                      | 'bitbucket'
                      | 'dsync'
                      | 'feedback'
                      | 'organization-teams';
                  commitId?: string;
                  repoId?: string;
                  repoPath?: string;
                  gitUserId?: string | number;
                  gitUserLogin?: string;
                  ssoUserId?: string;
                  ssoConnectedAt?: number;
                  idpUserId?: string;
                  dsyncUserId?: string;
                  dsyncConnectedAt?: number;
              };
          };
 
    /**
     * Will remain undocumented. Remove in v3 API.
     */
    created: string;
 
    /**
     * UNIX timestamp (in milliseconds) when the Team was created.
     */
    createdAt: number;
}