Skip to main content

Get a role

GET 
/api/web/v1/roles/:id

Get a specified role. Caller requires the ROLES:VIEW permission.

Request​

Path Parameters

    id stringrequired

    The UUID of the role to be fetched.

Responses​

Successful

Schema

    allRoles boolean

    A flag indicating if administrators with this role can manage all roles and all users.

    defaultRole boolean

    A flag indicating if this role is one of the default roles.

    description string

    The description of the role.

    groupIds string[]

    The UUIDs of groups associated with this role when Group Management is DEFINED. This attribute is ignored if Group Management is ALL or OWN.

    groupManagement string

    Possible values: [ALL, DEFINED, OWN]

    The type of the group management. Defaults to ALL if not provided.

    id string

    The UUID of the role.

    managedRoles undefined[]

    If allRoles is false, this attribute lists the roles and administrators in these roles thatcan be administered by administrators with this role. Administrators will also be able to manage end users.

    name stringrequired

    The name of the role.

    permissions

    object[]

    A list of the permissions assigned to this role.

  • Array [

    • actionType stringrequired

    Possible values: [VIEW, ADD, EDIT, REMOVE, ALL]

    The action to which this permission applies.

    entityType stringrequired

    Possible values: [ALL, SUBSCRIBERS, USERS, APPLICATIONS, TOKENS, ROLES, SPROLES, CONTEXTRULES, AUTHORIZATIONGROUPS, USERATTRIBUTES, USERATTRIBUTEVALUES, AGENTS, GROUPS, SETTINGS, DIRECTORIES, DIRECTORYSYNC, DIRECTORYCONNECTIONS, TEMPLATES, USERSITEROLES, REPORTS, BULKUSERS, BULKGROUPS, USERPASSWORDS, SERVICEPROVIDERS, SERVICEPROVIDERACCOUNTS, USERMACHINES, CAS, BULKHARDWARETOKENS, BULKSMARTCARDS, DIGITALIDCONFIGS, DIGITALIDCONFIGVARIABLES, DIGITALIDCONFIGCERTTEMPS, DIGITALIDCONFIGSANS, SCDEFNS, SCDEFNPIVAPPLETCONFIGS, SCDEFNVARIABLES, SMARTCREDENTIALS, SMARTCREDENTIALSSIGNATURE, USERSPROLES, EXPECTEDLOCATIONS, USERLOCATIONS, USERRBASETTINGS, SPCLIENTCREDENTIALS, SPMANAGEMENTPLATFORM, ENTITLEMENTS, QUESTIONS, USERQUESTIONS, USERQUESTIONANSWERS, USERKBACHALLENGES, WORDSYNONYMS, GATEWAYS, GATEWAYCSRS, SPUSERMGMT, BULKIDENTITYGUARD, TEMPACCESSCODES, TEMPACCESSCODECONTENTS, GRIDS, GRIDCONTENTS, FIDOTOKENS, EXPORTREPORTS, CUSTOMIZATIONVARIABLES, BLACKLISTEDPASSWORDS, SPENTITLEMENTS, CREATETENANT, TENANTS, ARCHIVES, CERTIFICATES, INTELLITRUSTDESKTOPS, ACTIVESYNC, PRINTERS, ISSUANCE, IDPROOFING, IDPROOFINGLICENSE, OTPS, AD_CONNECTOR_DIRECTORIES, AZURE_DIRECTORIES, SCHEDULEDTASKS, CREDENTIALDESIGNS, ENROLLMENTS, BULKENROLLMENTS, EMAILTEMPLATES, EMAILVARIABLES, SENDEMAIL, SENDSCIM, SENDAZUREAD, DIRECTORYPASSWORD, TRANSACTIONITEMS, TRANSACTIONRULES, ENROLLMENTDESIGNS, HIGH_AVAILABILITY_GROUPS, PKIAASCREDENTIALS, DIGITALIDCERTIFICATES, PIVCONTENTSIGNER, RESOURCESERVERAPIS, RESOURCESERVERSCOPES, USEROAUTHTOKENS, GROUPPOLICIES, OAUTHROLES, IDENTITYPROVIDERS, SMARTCARDS, IPLISTS, DOMAINCONTROLLERCERTS, OTPPROVIDERS, PREFERREDOTPPROVIDERS, SPIDENTITYPROVIDERS, PUSHCREDENTIALS, DIRECTORYSEARCHATTRIBUTES, DIRECTORYATTRIBUTES, RISKENGINES, SCIMPROVISIONINGS, RATELIMITING, CLAIMS, CONTACTVERIFICATION, HOSTNAMESETTINGS, MAGICLINKS, MAGICLINKCONTENTS, AUTHENTICATIONFLOWS, FACE, TOKENACTIVATIONCONTENTS, POLICYOVERRIDE, ORGANIZATIONS]

    The entity to which this permission applies.

    id stringrequired

    The UUID of this permission.

    roleType stringrequired

    Possible values: [SITE_ADMINISTRATOR, ACCOUNT_MANAGER]

    The role type to which this permission applies.

  • ]

    • roleType stringrequired

    Possible values: [SITE_ADMINISTRATOR, ACCOUNT_MANAGER]

    The type of the role.

    superAdministrator boolean

    A flag indicating if this role is a super administrator.

Loading...