CreateAccessGrantsResponse

Shape

• grantsarray of AccessGrantThe grants made. Empty for a preview.

  • The AccessGrant schema
  • created_atstring · date-time
  • grant_idGrantId (string · uuid)
  • roleRoleView

    • The RoleView schema
    • namestringThe role's display name: a built-in name such as Developer, or the custom role's name.
    • rankAccessLevelguestreporterdevelopermaintainerownerThe built-in rank the role counts as wherever a rank is compared, such as a protected branch's minimum.
    • builtinAccessLevelguestreporterdevelopermaintainerowneror nulloptionalSet when the role is built in.
    • customRoleId (string · uuid) or nulloptionalSet when the role is one the organization defined.
  • scopeAccessScopeWhere the grant was made.

    • The AccessScope schema
    • full_pathstring
    • idstring
    • typeScopeTypegrouprepository
  • subjectGrantSubject
  • updated_atstring · date-time
  • expires_atstring · date-time or nulloptional
  • granted_byActorSummary or nulloptionalWho made the grant. Absent for access the platform created — the creator of a group or repository, or a copied membership.

    • The ActorSummary schema
    • emailstring
    • idstring
    • usernamestring
    • avatar_urlstring or nulloptional
  • last_exercised_atstring · date-time or nulloptionalWhen the grant last let somebody do something, to the day. Absent until it has.
  • reasonstring or nulloptional
• unchangedarray of UnchangedGrantSubjects that already held the role here and were left as they were.

  • The UnchangedGrant schema
  • grant_idGrantId (string · uuid)
  • reasonUnchangedReasonalready_granted_same_roleWhy a subject named in a create request was left as it was.
  • subjectSubjectRef
• previewAccessPreview or nulloptionalPresent only for a preview: who would gain what. Nothing was written.

  • The AccessPreview schema
  • changesarray of AccessDeltaEach person whose access would change at the group or repository the change is made on.

    • The AccessDelta schema
    • gainsarray of stringPermissions they would hold that they do not hold now, by key.
    • lossesarray of stringPermissions they hold now that they would no longer hold, by key.
    • principalPrincipalSummary

      • The PrincipalSummary schema
      • idPrincipalId (string · uuid)
      • kindPrincipalKinduserservice_accountagentA person, a service account or an AI organization's agent.
      • usernamestring
      • avatar_urlstring or nulloptional
    • scopeAccessScope

      • The AccessScope schema
      • full_pathstring
      • idstring
      • typeScopeTypegrouprepository
    • rank_afterAccessLevelguestreporterdevelopermaintainerowneror nulloptional
    • rank_beforeAccessLevelguestreporterdevelopermaintainerowneror nulloptional
  • summaryAccessPreviewSummary

    • The AccessPreviewSummary schema
    • people_gaininginteger · int320–∞
    • people_losinginteger · int320–∞
    • scopes_affectedinteger · int64The group or repository the change is made on, plus every one beneath it that inherits access and so changes with it.
  • truncatedbooleanWhether changes stops short of everyone affected. The summary still counts them all.

Graph

Used by