GuidesChangelogTypeScript API ReferencePython v2 API Reference

RoleEntityInfo

Details about the role entity. The provided fields are dependent on the entityType as provided. User: userId, userHrn, realm, firstname, lastname, email, state App: clientId, clientHrn, realm, name, description, ownerId, ownerHrn, defaultScope, isRestrictedScope, appCreationEnabled

Hierarchy

Index

Properties

Properties

Optional appCreationEnabled

appCreationEnabled?: boolean

If true, the app can create apps.

Optional clientHrn

clientHrn?: string

HRN for the client/application.

Optional clientId

clientId?: string

Identifier for the client/application.

Optional defaultScope

defaultScope?: string

The default value for the "scope" parameter when requesting a client_credentials OAuth2 token. if no "scope" parameter is specified.

Optional description

description?: string

Prose description of the client.

Optional email

email?: string

Email address of the user. Only included if entityType is user.

Optional firstname

firstname?: string

The first name of the user. Only included if entityType is user.

Optional isRestrictedScope

isRestrictedScope?: boolean

If true, the app cannot request a token with a scope different from defaultScope.

Optional lastname

lastname?: string

The lastname of the user. Only included if entityType is user.

Optional name

name?: string

Human readable name of the client.

Optional ownerHrn

ownerHrn?: string

The hrn of the user that owns this client.

Optional ownerId

ownerId?: string

The id of the user that owns this client.

Optional realm

realm?: string

A realm to which app belongs to.

Optional state

state?: "deleted" | "disabled" | "locked" | "enabled"

The status of this user.

Optional userHrn

userHrn?: string

The HRN of the user.

Optional userId

userId?: string

The unique identifier of the user.

olp- sdk- dataservice- api

Role Entity Info