Skip to main content

PortalUser

No description

type PortalUser implements BaseFields {
  accesses(
    showTeamAccess: Boolean = false
  ): [Access!]!
  allocatedAnalyses(
    companyId: Int!
  ): [Project!]
  avatarFilename: String
  avatarId: String
  avatarSize: String
  avatarUrl: String
  basis: Boolean!
  blocked: Boolean
  createdAt: ISO8601DateTime!
  deleted: Boolean!
  displayName: String!
  effectiveAbilities(
    companyId: ID!
  ): [EffectiveAbility!]!
  effectiveCertificatePermissions(
    companyId: ID!
  ): [CertificatePermissions!]!
  effectiveTicketPermissions(
    companyId: ID!
  ): [TicketsPermissions!]!
  effectiveUserAccessPermissions(
    companyId: ID!
  ): [UserAccessPermissions!]!
  email: String!
  hasAccess(
    companyId: ID!
  ): Boolean!
  id: ID!
  inactive: Boolean
  invite(
    companyId: ID!
  ): Invite
  isAdmin(
    companyId: ID!
  ): Boolean!
  jobPosition(
    companyId: ID!
  ): JobPositionsEnum
  kind: PrincipalKindEnum!
  mustChangePassword: Boolean!
  name: String
  pendingDeploys(
    companyId: Int!
  ): [PendingDeploy!]
  profile(
    companyId: ID!
  ): PortalUserAccessProfiles!
  qrcodeUri: String
  reviewedDeploys(
    initialDate: ISO8601DateTime!
    finishDate: ISO8601DateTime!
    companyId: Int!
  ): [Deploy!]
  sso: Boolean
  superUser: Boolean!
  teams(
    companyId: ID!
  ): [Team!]
  twoFactor: Boolean!
  updatedAt: ISO8601DateTime!
}

Fields​

PortalUser.accesses ● [Access!]! non-null object​

Accesses granted to the user.

PortalUser.accesses.showTeamAccess ● Boolean scalar​

PortalUser.allocatedAnalyses ● [Project!] list object​

Projects the user is allocated to

PortalUser.allocatedAnalyses.companyId ● Int! non-null scalar​

The company ID to fetch the allocated projects

PortalUser.avatarFilename ● String scalar​

The filename of the user's avatar image

PortalUser.avatarId ● String scalar​

The id of the user's avatar image

PortalUser.avatarSize ● String scalar​

The size of the user's avatar image

PortalUser.avatarUrl ● String scalar​

The URL of the user's avatar image

PortalUser.basis ● Boolean! non-null scalar​

True for a Conviso employee: a @conviso.com.br / @convisoappsec.com email, or a super user. This is the identity Assets::Concerns::TypeChangeAuth gates on, so a client hiding a staff-only control must read this and not superUser, which is the narrower explicit id list.

PortalUser.blocked ● Boolean scalar​

Indicates if the user is blocked

PortalUser.createdAt ● ISO8601DateTime! non-null scalar​

The date when record was created

PortalUser.deleted ● Boolean! non-null scalar​

Whether the user was deleted. History keeps showing deleted users

PortalUser.displayName ● String! non-null scalar​

The user's name, or the email address when there is no name

PortalUser.effectiveAbilities ● [EffectiveAbility!]! non-null object​

Effective module abilities for the user on a specific company. Each ability requires both the product-plan grant and the Policy predicate the GraphQL API authorizes against (plan ∧ policy). Actions are authorization hints (e.g. SHOW), not plan entitlement (READ/CREATE/...) from company.planContext.permissions. Returns [] when the company is inaccessible (UI-hint fields must not null the parent currentUserProfile payload).

PortalUser.effectiveAbilities.companyId ● ID! non-null scalar​

PortalUser.effectiveCertificatePermissions ● [CertificatePermissions!]! non-null enum​

Effective SSL certificate permissions for the user on a specific company, as decided by CertificatePolicy — the same source the API itself authorizes against.

PortalUser.effectiveCertificatePermissions.companyId ● ID! non-null scalar​

PortalUser.effectiveTicketPermissions ● [TicketsPermissions!]! non-null enum​

Effective ticket permissions for the user on a specific company, as decided by TicketPolicy — the same source the API itself authorizes against. Returns [] when the company is inaccessible (UI-hint fields must not null the parent currentUserProfile payload).

PortalUser.effectiveTicketPermissions.companyId ● ID! non-null scalar​

PortalUser.effectiveUserAccessPermissions ● [UserAccessPermissions!]! non-null enum​

Effective user access permissions for the user on a specific company, merging the directly bound profile with profiles inherited from teams.

PortalUser.effectiveUserAccessPermissions.companyId ● ID! non-null scalar​

PortalUser.email ● String! non-null scalar​

The user's email address. A service account returns its name

PortalUser.hasAccess ● Boolean! non-null scalar​

Return true if user has any access to this company.

PortalUser.hasAccess.companyId ● ID! non-null scalar​

PortalUser.id ● ID! non-null scalar​

The ID scalar type represents a unique identifier

PortalUser.inactive ● Boolean scalar​

Indicates if the user is inactive

PortalUser.invite ● Invite object​

Invite received by the user

PortalUser.invite.companyId ● ID! non-null scalar​

The company ID to retrieve the invite information for the user

PortalUser.isAdmin ● Boolean! non-null scalar​

Return true if user is Admin of a company.

PortalUser.isAdmin.companyId ● ID! non-null scalar​

PortalUser.jobPosition ● JobPositionsEnum enum​

Returns the job position of the user in the specified company, or nil if none.

PortalUser.jobPosition.companyId ● ID! non-null scalar​

PortalUser.kind ● PrincipalKindEnum! non-null enum​

Whether the user is a person, a service account or a platform identity

PortalUser.mustChangePassword ● Boolean! non-null scalar​

Indicates if the user must change password

PortalUser.name ● String scalar​

The user's name

PortalUser.pendingDeploys ● [PendingDeploy!] list object​

Pending Deploys of the user

PortalUser.pendingDeploys.companyId ● Int! non-null scalar​

The company ID to fetch pending deploys

PortalUser.profile ● PortalUserAccessProfiles! non-null object​

Profile associated for user on specific company.

PortalUser.profile.companyId ● ID! non-null scalar​

PortalUser.qrcodeUri ● String scalar​

The URI for the user's QR code for two-factor authentication

PortalUser.reviewedDeploys ● [Deploy!] list object​

Deploys reviewed by the user

PortalUser.reviewedDeploys.initialDate ● ISO8601DateTime! non-null scalar​

The start date for the review period

PortalUser.reviewedDeploys.finishDate ● ISO8601DateTime! non-null scalar​

The end date for the review period

PortalUser.reviewedDeploys.companyId ● Int! non-null scalar​

The company ID to fetch the reviewed deploys

PortalUser.sso ● Boolean scalar​

Indicates if the user has SSO enabled

PortalUser.superUser ● Boolean! non-null scalar​

PortalUser.teams ● [Team!] list object​

Teams the user belongs to

PortalUser.teams.companyId ● ID! non-null scalar​

The company ID to fetch the user's teams

PortalUser.twoFactor ● Boolean! non-null scalar​

Indicates if the user has two-factor authentication enabled

PortalUser.updatedAt ● ISO8601DateTime! non-null scalar​

The date when record was updated

Interfaces​

BaseFields interface​

Returned By​

currentUserProfile query ● portalUserProfile query

Member Of​

ApiFinding object ● Attachment object ● CloudFinding object ● ContainerFinding object ● DastFinding object ● Deploy object ● FindingInterface interface ● IacFinding object ● Invite object ● IssueInterface interface ● IssueStatusHistory object ● MastFinding object ● NetworkVulnerability object ● Notification object ● PCIAssessment object ● PCIAssessmentControl object ● PCIEvidence object ● PCIRemediationAction object ● PortalUserAccess object ● PortalUserCollection object ● ResendInvitePayload object ● SastFinding object ● ScaFinding object ● SecretFinding object ● SourceCodeVulnerability object ● Team object ● ThreatModelArtifactVersion object ● UpdateIssueAssigneesPayload object ● UpdatePortalUserPasswordPayload object ● VulnerabilityDisclosureMessage object ● VulnerabilityDisclosureSubmission object ● VulnerabilityInterface interface ● WebVulnerability object

Contribute to the Docs

Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.

How to contribute

Resources

By exploring our content, you'll find resources that will enhance your understanding of the importance of a Security Application Program.

Conviso Blog: Explore our blog, which offers a collection of articles and posts covering a wide range of AppSec topics. The content on the blog is primarily in English.

Conviso's YouTube Channel: Access a wealth of informative videos covering various topics related to AppSec. Please note that the content is primarily in Portuguese.