Organization
Users and User Groups
    API tokens
    Users - Entity APIs
    Users - Declarative APIs
    UserGroups - Entity APIs
    UserGroups - Declarative APIs
    User Authorization
      Invite UserpostGet all usersgetCreate a userpostGet a usergetUpdate a userputDelete a userdeleteGet Profileget
    User Settings
    User Identifiers
    User management
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

User Authorization (3.51)

Endpoint:/

Invite User

POST
/api/v1/actions/invite

Puts a new invitation requirement into the invitation generator queue. This is a GoodData Cloud specific endpoint.

Invite User › Request Body

  • emailstring · email · required
  • userIdstring · required
  • firstNamestring
  • lastNamestring

Invite User › Responses

No Content

No data returned
POST /api/v1/actions/invite

Get all users

GET
/api/v1/auth/users

Get all users - dedicated endpoint for user management in the internal OIDC provider. GoodData.CN specific

Get all users › Responses

OK

  • displayNamestring · required

    User description, which will be visible in application.

    Example: jeremy
  • emailstring · required

    Email - used as lookup (must be unique). For PUT method, it must be same as in URL

    Example: zeus@example.com
  • authenticationIdstring

    Field, which should be stored in metadata in authenticationId field. In PUT and POST method it must be not present, or equal to value calculated by backend (e.g. returned from previous GET).

  • passwordstring

    User password. It is not returned by GET method.

GET /api/v1/auth/users

Create a user

POST
/api/v1/auth/users

Create a user - dedicated endpoint for user management in the internal OIDC provider. GoodData.CN specific

Create a user › Request Body

  • displayNamestring · required

    User description, which will be visible in application.

    Example: jeremy
  • emailstring · required

    Email - used as lookup (must be unique). For PUT method, it must be same as in URL

    Example: zeus@example.com
  • authenticationIdstring

    Field, which should be stored in metadata in authenticationId field. In PUT and POST method it must be not present, or equal to value calculated by backend (e.g. returned from previous GET).

  • passwordstring

    User password. It is not returned by GET method.

Create a user › Responses

OK

  • displayNamestring · required

    User description, which will be visible in application.

    Example: jeremy
  • emailstring · required

    Email - used as lookup (must be unique). For PUT method, it must be same as in URL

    Example: zeus@example.com
  • authenticationIdstring

    Field, which should be stored in metadata in authenticationId field. In PUT and POST method it must be not present, or equal to value calculated by backend (e.g. returned from previous GET).

  • passwordstring

    User password. It is not returned by GET method.

POST /api/v1/auth/users

Get a user

GET
/api/v1/auth/users/{userEmail}

Get a user - dedicated endpoint for user management in the internal OIDC provider. GoodData.CN specific

Get a user › path Parameters

  • userEmailstring · required

Get a user › Responses

OK

  • displayNamestring · required

    User description, which will be visible in application.

    Example: jeremy
  • emailstring · required

    Email - used as lookup (must be unique). For PUT method, it must be same as in URL

    Example: zeus@example.com
  • authenticationIdstring

    Field, which should be stored in metadata in authenticationId field. In PUT and POST method it must be not present, or equal to value calculated by backend (e.g. returned from previous GET).

  • passwordstring

    User password. It is not returned by GET method.

GET /api/v1/auth/users/{userEmail}

Update a user

PUT
/api/v1/auth/users/{userEmail}

Update a user - dedicated endpoint for user management in the internal OIDC provider. GoodData.CN specific

Update a user › path Parameters

  • userEmailstring · required

Update a user › Request Body

  • displayNamestring · required

    User description, which will be visible in application.

    Example: jeremy
  • emailstring · required

    Email - used as lookup (must be unique). For PUT method, it must be same as in URL

    Example: zeus@example.com
  • authenticationIdstring

    Field, which should be stored in metadata in authenticationId field. In PUT and POST method it must be not present, or equal to value calculated by backend (e.g. returned from previous GET).

  • passwordstring

    User password. It is not returned by GET method.

Update a user › Responses

OK

  • displayNamestring · required

    User description, which will be visible in application.

    Example: jeremy
  • emailstring · required

    Email - used as lookup (must be unique). For PUT method, it must be same as in URL

    Example: zeus@example.com
  • authenticationIdstring

    Field, which should be stored in metadata in authenticationId field. In PUT and POST method it must be not present, or equal to value calculated by backend (e.g. returned from previous GET).

  • passwordstring

    User password. It is not returned by GET method.

PUT /api/v1/auth/users/{userEmail}

Delete a user

DELETE
/api/v1/auth/users/{userEmail}

Delete a user - dedicated endpoint for user management in the internal OIDC provider. GoodData.CN specific

Delete a user › path Parameters

  • userEmailstring · required

Delete a user › Responses

No Content

No data returned
DELETE /api/v1/auth/users/{userEmail}

Get Profile

GET
/api/v1/profile

Returns a Profile including Organization and Current User Information.

Get Profile › Responses

OK

  • entitlementsobject[] · required

    Defines entitlements for given organization.

  • featuresrequired
  • linksobject · required
  • organizationIdstring · required
  • organizationNamestring · required
  • permissionsstring[] · required
    Enum values:
    MANAGE
    SELF_CREATE_TOKEN
  • telemetryConfigobject · required

    Telemetry-related configuration.

  • userIdstring · required
  • namestring
GET /api/v1/profile
UserGroups - Declarative APIsUser Settings